|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface URLAccessorFactory
Factory for obtaining EngineURL
objects for a given state or
resource URLs pointing to a portal resource.
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.
Method Summary | |
---|---|
ResourceURLAccessor |
newResourceURL(javax.servlet.http.HttpServletRequest req)
Deprecated. Creates an accessor object that can generate links to resources in the portal application. |
ResourceURLAccessor |
newResourceURL(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse resp)
Creates an accessor object that can generate links to resources in the portal application. |
ResourceURLAccessor |
newResourceURL(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse resp,
StateHolder state)
Deprecated. Creates an accessor object that can generate links to resources in the portal application. |
ResourceURLAccessor |
newResourceURL(javax.servlet.http.HttpServletRequest req,
StateHolder state)
Deprecated. Creates an accessor object that can generate links to resources in the portal application. |
ResourceURLAccessor |
newResourceURL(ServerContext serverContext,
java.util.Locale locale,
javax.ccpp.Profile profile,
boolean isSecure)
Creates a resource URL accessor that can generate links to generic resources such as files, icons, voice grammars etc. |
ServerContext |
newServerContext(javax.servlet.http.HttpServletRequest req)
Constructs a new server context |
EngineURL |
newURL(javax.servlet.http.HttpServletRequest req,
Constants.Clone type)
Deprecated. Returns a 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 engine URL will not modify the original state. |
EngineURL |
newURL(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse resp,
Constants.Clone type)
Returns a EngineURL object based on the information in the
given servlet request. |
EngineURL |
newURL(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse resp,
ServerContext serverContext,
URLContext allowedContext,
boolean isSecure,
boolean isProtected,
StateHolder state,
Constants.Clone type)
Returns a EngineURL object based on explicit host, port and
context information. |
EngineURL |
newURL(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse resp,
StateHolder state,
Constants.Clone type)
Returns an EngineURL object based on the information in the
given servlet request. |
EngineURL |
newURL(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse resp,
StateHolder state,
URLContext allowedContext,
Constants.Clone type)
Returns an EngineURL object based on the information in the
given servlet request. |
EngineURL |
newURL(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse resp,
URLContext allowedContext,
Constants.Clone type)
Returns a EngineURL object based on the information in the
given servlet request. |
EngineURL |
newURL(javax.servlet.http.HttpServletRequest req,
StateHolder state,
Constants.Clone type)
Deprecated. Returns a 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 engine URL will not modify the original state. |
EngineURL |
newURL(javax.servlet.http.HttpServletRequest req,
StateHolder state,
URLContext allowedContext,
Constants.Clone type)
Deprecated. Returns a 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 engine URL will not modify the original state. |
EngineURL |
newURL(javax.servlet.http.HttpServletRequest req,
URLContext allowedContext,
Constants.Clone type)
Deprecated. Returns a 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 engine URL will not modify the original state. |
EngineURL |
newURL(ServerContext context,
boolean isSecure,
boolean isProtected,
StateHolder state,
Constants.Clone type)
Returns a EngineURL object based on explicit host, port and
context information. |
EngineURL |
newURL(ServerContext serverContext,
URLContext allowedContext,
boolean isSecure,
boolean isProtected,
StateHolder state,
Constants.Clone type)
Returns a EngineURL object based on explicit host, port and
context information. |
Methods inherited from interface com.ibm.portal.state.accessors.AccessorFactory |
---|
compact |
Method Detail |
---|
@Deprecated ResourceURLAccessor newResourceURL(javax.servlet.http.HttpServletRequest req) throws StateNotInRequestException, ResourceUrlException
req
- the current servlet request
StateNotInRequestException
- - if no state could be associated with the request
ResourceUrlException
- - if the URL accessor could not be initializedResourceURLAccessor newResourceURL(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) throws ResourceUrlException
req
- the current servlet requestresp
- servlet response, required to perform encodeURL
ResourceUrlException
- - if the URL accessor could not be initialized@Deprecated ResourceURLAccessor newResourceURL(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, StateHolder state) throws ResourceUrlException
req
- the current servlet requestresp
- servlet response, required to perform encodeURLstate
- the state that specifies the current theme, must not be null
ResourceUrlException
- - if the URL accessor could not be initialized@Deprecated ResourceURLAccessor newResourceURL(javax.servlet.http.HttpServletRequest req, StateHolder state) throws ResourceUrlException
req
- the current servlet requeststate
- the state that specifies the current theme, must not be null
ResourceUrlException
- - if the URL accessor could not be initializedResourceURLAccessor newResourceURL(ServerContext serverContext, java.util.Locale locale, javax.ccpp.Profile profile, boolean isSecure) throws ResourceUrlException
ServerContext
.
serverContext
- The ServerContext
providing server-related
information (e.g. hostname, port etc.). Must not be
null
.locale
- Locale
which is needed to create resource URLs
that address locale-specific resources (e.g. icons). May be
null
.profile
- CCPP profile that characterizes the capabilities of a certain
user agent. May be null
.isSecure
- Boolean flag specifying whether the resource URL should be
served using a secure connection (https).
ResouceURLAccessor
serving as a factory for
resource URLs. Not null
.
ResourceUrlException
- If the ResourceURLAccessor
cannot be created and
initialized properly.@Deprecated EngineURL newURL(javax.servlet.http.HttpServletRequest req, Constants.Clone type) throws CannotCloneDocumentModelException, CannotCreateDocumentException, StateNotInRequestException, InvalidConstantException
req
- servlet request to retrieve server, portal and context
information fromtype
- 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
StateNotInRequestException
- - if no state could be associated with the requestEngineURL newURL(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, Constants.Clone type) throws CannotCloneDocumentModelException, CannotCreateDocumentException, StateNotInRequestException, InvalidConstantException
EngineURL
object based on the information in the
given servlet request. The object operates on a copy of the
request-specific state holder, so setting parameters to the engine URL
will not modify the original request-specific state.
req
- The servlet request to retrieve server, portal and context
information from. Must not be null
.resp
- The servlet response, required to perform encodeURL. 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.
EngineURL
object. Not null
.
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.
StateNotInRequestException
- If no state could be associated with the request.EngineURL newURL(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, ServerContext serverContext, URLContext allowedContext, boolean isSecure, boolean isProtected, StateHolder state, Constants.Clone type) throws CannotCloneDocumentModelException, CannotCreateDocumentException, InvalidConstantException
EngineURL
object based on explicit host, port and
context information. The object operates on a copy of the state holder,
so setting parameters to the engine URL will not modify the original
state. allowedContext
argument refers to the type of the URL to
be generated i.e. it specifies whether the created URL may be absolute,
server-relative or relative. Note that this argument cannot enforce that
the URL is server-relative or relative. For example in case of a protocol
switch (e.g. http to https), the URL must be absolute in any case.
serverContext
- Specifies the needed server information. Must not be
null
.allowedContext
- Specifies the type (absolute, server-relative, or relative) of
the URL that should be generated. Must not be
null
.isSecure
- Boolean flag indicating whether the generated URL should by
default result in a secure connection using the https
protocol. true
implies the https protocol,
false
http.isProtected
- Boolean flag indicating whether the generated URL should by
default point to the protected portal domain or not.
true
means that the URL points to the protected
domain, false
that it addresses the public
domain.state
- Original state holder the URL should be based on. May 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
Constants.Clone.SMART_COPY
will be generated.
EngineURL
object. Not null
.
CannotCloneDocumentModelException
- If the state could not be cloned.
CannotCreateDocumentException
- If the wrapper around the state could not be created.
InvalidConstantException
- If the given clone type is not supported.EngineURL newURL(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, StateHolder state, Constants.Clone type) throws CannotCloneDocumentModelException, CannotCreateDocumentException, InvalidConstantException
EngineURL
object based on the information in the
given servlet request. The object operates on a copy of the given state
holder, so setting parameters to the engine URL will not modify the
original state.
req
- The servlet request to retrieve server, portal and context
information from. Must not be null
.resp
- The servlet response, required to perform encodeURL. Must not
be null
.state
- The original state holder that should be cloned for this URL.
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.
EngineURL
object. Not null
.
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.EngineURL newURL(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, StateHolder state, URLContext allowedContext, Constants.Clone type) throws CannotCloneDocumentModelException, CannotCreateDocumentException, InvalidConstantException
EngineURL
object based on the information in the
given servlet request. The object operates on a copy of the given state
holder, so setting parameters to the engine URL will not modify the
original state.
req
- The servlet request to retrieve server, portal and context
information from. Must not be null
.resp
- The servlet response, required to perform encodeURL. Must not
be null
.state
- The original state holder that should be cloned for this URL.
Must not be null
.allowedContext
- Context object specifying the type of the requested URL
(absolute, server-relative, or relative). May be
null
to indicate that the server's default URL
context should be used.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.
EngineURL
object. Not null
.
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.EngineURL newURL(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, URLContext allowedContext, Constants.Clone type) throws CannotCloneDocumentModelException, CannotCreateDocumentException, StateNotInRequestException, InvalidConstantException
EngineURL
object based on the information in the
given servlet request. The object operates on a copy of the
request-specific state holder, so setting parameters to the engine URL
will not modify the original request-specific state.
req
- The servlet request to retrieve server, portal and context
information from. Must not be null
.resp
- The servlet response, required to perform encodeURL. Must not
be null
.allowedContext
- Context object specifying the type of the requested URL
(absolute, server-relative, or relative). May be
null
to indicate that the server's default URL
context should be used.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.
EngineURL
object. Not null
.
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.
StateNotInRequestException
- If no state could be associated with the request.@Deprecated EngineURL newURL(javax.servlet.http.HttpServletRequest req, StateHolder state, Constants.Clone type) throws CannotCloneDocumentModelException, 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@Deprecated EngineURL newURL(javax.servlet.http.HttpServletRequest req, StateHolder state, URLContext allowedContext, Constants.Clone type) throws CannotCloneDocumentModelException, 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.allowedContext
- specifies what type of URLs may be generated. May be null to
not limit the URL generation
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@Deprecated EngineURL newURL(javax.servlet.http.HttpServletRequest req, URLContext allowedContext, Constants.Clone type) throws CannotCloneDocumentModelException, CannotCreateDocumentException, StateNotInRequestException, InvalidConstantException
req
- servlet request to retrieve server, portal and context
information fromtype
- 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.allowedContext
- specifies what type of URLs may be generated. May be null to
not limit the URL generation
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
StateNotInRequestException
- - if no state could be associated with the requestEngineURL newURL(ServerContext context, boolean isSecure, boolean isProtected, StateHolder state, Constants.Clone type) throws CannotCloneDocumentModelException, CannotCreateDocumentException, InvalidConstantException
EngineURL
object based on explicit host, port and
context information. The object operates on a copy of the state holder,
so setting parameters to the engine URL will not modify the original
state. Note that the created URL will be absolute.
context
- Specifies the needed server information. Must not be
null
.isSecure
- Boolean flag indicating whether the generated URL should by
default result in a secure connection using the https
protocol. true
implies the https protocol,
false
http.isProtected
- Boolean flag indicating whether the generated URL should by
default point to the protected portal domain or not.
true
means that the URL points to the protected
domain, false
that it addresses the public
domain.state
- Original state holder the URL should be based on. May 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
Constants.Clone.SMART_COPY
will be generated.
EngineURL
object. Not null
.
CannotCloneDocumentModelException
- If the state could not be cloned.
CannotCreateDocumentException
- If the wrapper around the state could not be created.
InvalidConstantException
- If the given clone type is not supported.EngineURL newURL(ServerContext serverContext, URLContext allowedContext, boolean isSecure, boolean isProtected, StateHolder state, Constants.Clone type) throws CannotCloneDocumentModelException, CannotCreateDocumentException, InvalidConstantException
EngineURL
object based on explicit host, port and
context information. The object operates on a copy of the state holder,
so setting parameters to the engine URL will not modify the original
state. allowedContext
argument refers to the type of the URL to
be generated i.e. it specifies whether the created URL may be absolute,
server-relative or relative. Note that this argument cannot enforce that
the URL is server-relative or relative. For example in case of a protocol
switch (e.g. http to https), the URL must be absolute in any case.
serverContext
- Specifies the needed server information. Must not be
null
.allowedContext
- Specifies the type (absolute, server-relative, or relative) of
the URL that should be generated. Must not be
null
.isSecure
- Boolean flag indicating whether the generated URL should by
default result in a secure connection using the https
protocol. true
implies the https protocol,
false
http.isProtected
- Boolean flag indicating whether the generated URL should by
default point to the protected portal domain or not.
true
means that the URL points to the protected
domain, false
that it addresses the public
domain.state
- Original state holder the URL should be based on. May 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
Constants.Clone.SMART_COPY
will be generated.
EngineURL
object. Not null
.
CannotCloneDocumentModelException
- If the state could not be cloned.
CannotCreateDocumentException
- If the wrapper around the state could not be created.
InvalidConstantException
- If the given clone type is not supported.ServerContext newServerContext(javax.servlet.http.HttpServletRequest req) throws StateException
req
-
StateException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |