001/*
002 * Copyright 2002-2012 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.aop.scope;
018
019import org.springframework.aop.RawTargetAccess;
020
021/**
022 * An AOP introduction interface for scoped objects.
023 *
024 * <p>Objects created from the {@link ScopedProxyFactoryBean} can be cast
025 * to this interface, enabling access to the raw target object
026 * and programmatic removal of the target object.
027 *
028 * @author Rod Johnson
029 * @author Juergen Hoeller
030 * @since 2.0
031 * @see ScopedProxyFactoryBean
032 */
033public interface ScopedObject extends RawTargetAccess {
034
035        /**
036         * Return the current target object behind this scoped object proxy,
037         * in its raw form (as stored in the target scope).
038         * <p>The raw target object can for example be passed to persistence
039         * providers which would not be able to handle the scoped proxy object.
040         * @return the current target object behind this scoped object proxy
041         */
042        Object getTargetObject();
043
044        /**
045         * Remove this object from its target scope, for example from
046         * the backing session.
047         * <p>Note that no further calls may be made to the scoped object
048         * afterwards (at least within the current thread, that is, with
049         * the exact same target object in the target scope).
050         */
051        void removeFromScope();
052
053}