|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CheckedURLAccessorFactory
The CheckedURLAccessorFactory
creates
CheckedEngineURLs
which allow setting
access control checks on the generated URL.
NOTE: This API may only be used in the scope of an HTTP request in WebSphere Portal, i.e. within a theme.
The API can not be invoked directly by a custom servlet.
CheckedEngineURL
Method Summary | |
---|---|
CheckedEngineURL |
newURL(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse resp,
Constants.Clone type)
Returns a checked URL object based on the information in the servlet request. |
CheckedEngineURL |
newURL(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse resp,
StateHolder state,
Constants.Clone type)
Returns a checked URL object based on the information in the servlet request. |
CheckedEngineURL |
newURL(javax.servlet.http.HttpServletRequest req,
StateHolder state,
Constants.Clone type)
Deprecated. Returns a checked URL object based on the information in the servlet request. The object operates on a copy of the state holder, so setting parameters to the checked engine URL will not modify the original state. |
CheckedEngineURL |
newURL(ServerContext context,
boolean isSecure,
boolean isProtected,
StateHolder state,
Constants.Clone type)
Returns a checked URL object based on explicit host, port and context information. |
Methods inherited from interface com.ibm.portal.state.accessors.AccessorFactory |
---|
compact |
Method Detail |
---|
CheckedEngineURL newURL(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, Constants.Clone type) throws StateNotInRequestException, CannotCloneDocumentModelException, UnknownAccessorTypeException, CannotInstantiateAccessorException, CannotCreateDocumentException, InvalidConstantException
req
- servlet request to retrieve server, portal and context information from (must not be null)resp
- servler response, required to perform encodeURLtype
- type of the clone operation to get a copy of the state holder for the URL,
may be null in which case a SMART_COPY will be generated.
CannotCloneDocumentModelException
- - if the state could not be cloned
CannotCreateDocumentException
- - if a wrapper around the state could not be created
InvalidConstantException
- - if the clone type is not supported
UnknownAccessorTypeException
- - if the class object does not refer to a valid factory
CannotInstantiateAccessorException
- - if the factory type has been recognized, but the factory could not be instantiated
StateNotInRequestException
- - if no state could be associated with the requestCheckedEngineURL newURL(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, StateHolder state, Constants.Clone type) throws CannotCloneDocumentModelException, UnknownAccessorTypeException, CannotInstantiateAccessorException, CannotCreateDocumentException, InvalidConstantException
req
- servlet request to retrieve server, portal and context information from (must not be null)resp
- servlet response, required to perform encodeURLstate
- original state holder (must not be null)type
- type of the clone operation to get a copy of the state holder for the URL,
may be null in which case a SMART_COPY will be generated.
CannotCloneDocumentModelException
- - if the state could not be cloned
CannotCreateDocumentException
- - if a wrapper around the state could not be created
InvalidConstantException
- - if the clone type is not supported
UnknownAccessorTypeException
- - if the class object does not refer to a valid factory
CannotInstantiateAccessorException
- - if the factory type has been recognized, but the factory could not be instantiatedCheckedEngineURL newURL(javax.servlet.http.HttpServletRequest req, StateHolder state, Constants.Clone type) throws CannotCloneDocumentModelException, UnknownAccessorTypeException, CannotInstantiateAccessorException, CannotCreateDocumentException, InvalidConstantException
req
- servlet request to retrieve server, portal and context information from (must not be null)state
- original state holder (must not be null)type
- type of the clone operation to get a copy of the state holder for the URL,
may be null in which case a SMART_COPY will be generated.
CannotCloneDocumentModelException
- - if the state could not be cloned
CannotCreateDocumentException
- - if a wrapper around the state could not be created
InvalidConstantException
- - if the clone type is not supported
UnknownAccessorTypeException
- - if the class object does not refer to a valid factory
CannotInstantiateAccessorException
- - if the factory type has been recognized, but the factory could not be instantiatedCheckedEngineURL newURL(ServerContext context, boolean isSecure, boolean isProtected, StateHolder state, Constants.Clone type) throws UnknownAccessorTypeException, CannotInstantiateAccessorException, CannotCloneDocumentModelException, CannotCreateDocumentException, InvalidConstantException
context
- specifies the server informationisSecure
- true if the default for the generated URL should be HTTPSisProtected
- true if the default for the generated URL should be the protected domainstate
- original state holdertype
- type of the clone operation to get a copy of the state holder for the URL,
may be null in which case a SMART_COPY will be generated.
CannotCloneDocumentModelException
- - if the state could not be cloned
CannotCreateDocumentException
- - if a wrapper around the state could not be created
InvalidConstantException
- - if the clone type is not supported
UnknownAccessorTypeException
- - if he class object does not refer to a valid factory
CannotInstantiateAccessorException
- - if he factory type has been recognized, but the factory could not be instantiated
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |