|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface StateManagerService
Service interface that allows for creating a variety of URLs. URLs can be
obtained via the URLFactory
interface. To modify the
navigational state that is carried by a URL, the State Accessor SPI can be
used. The State Accessor SPI provides so-called state accessors for a variety
of state aspects (e.g. portlet-related state, page selection information,
theme template information etc.). The state accessors are each accessible via
a special accessor factory (see com.ibm.portal.state.accessors.*
packages) that can be obtained using the getAccessorFactory()
method of this service.
Note that this service interface is derived from the Disposable
interface which means that the programmer using this interface must
explicitly indicate when the service is no longer used by invoking the
offered dispose()
method. Typically the maximum lifetime of the
service is one servlet request. However, their might be implementations that
are not tied to a servlet request possibly implying a longer lifetime.
Method Summary | ||
---|---|---|
|
getAccessorFactory(java.lang.Class<T> cls)
Get a factory that provides accessors for typed access on the state holder. |
|
ServerContext |
getServerContext()
Returns the server context for the state manager |
|
URLFactory |
getURLFactory()
Provides access to the URLFactory . |
|
URLFactory |
getURLFactory(ServerContext aServerContext)
Provides access to the URLFactory . |
Methods inherited from interface com.ibm.portal.Disposable |
---|
dispose |
Method Detail |
---|
<T> T getAccessorFactory(java.lang.Class<T> cls) throws UnknownAccessorTypeException, CannotInstantiateAccessorException
cls
- Class object for the accessor factory type (refers to the
accessor factory interface, not to its implementation). Must
not be null
.
null
.
UnknownAccessorTypeException
- If the class object cannot be mapped to a valid accessor
factory.
CannotInstantiateAccessorException
- If the factory type is known but cannot be instantiated.ServerContext getServerContext()
getServerContext
in interface ServerContextProvider
null
URLFactory getURLFactory() throws CannotInstantiateURLFactoryException
URLFactory
. The
URLFactory
provides various methods to create engine URLs as
well as resource URLs.
URLFactory
instance. Not null
.
CannotInstantiateURLFactoryException
- If the URLFactory
cannot be instantiated or
initialized properly.URLFactory getURLFactory(ServerContext aServerContext) throws CannotInstantiateURLFactoryException
URLFactory
. The
URLFactory
provides various methods to create engine URLs as
well as resource URLs in the context for an explicit server.
aServerContext
- the explicit server context
URLFactory
instance. Not null
.
CannotInstantiateURLFactoryException
- If the URLFactory
cannot be instantiated or
initialized properly.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |