Tree PREV CLASS NEXT CLASS SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD com.ibm.portal.resolver.friendly.accessors.url
Interface FriendlyURLFactory
- All Superinterfaces:
- ServerContextProvider
public interface FriendlyURLFactory- extends ServerContextProvider
Provides access to FriendlyURL objects that allow to systematically generate URLs with a friendly prefix.
- Since:
- 6.1.0
Method Summary ServerContext getServerContext()
Returns information about the URL configuration in the scope of the current request.FriendlyURL newURL()
Generates a URL that points to the portal servlet and it based on the navigational state of the current request.FriendlyURL newURL(Constants.Clone type)
Generates a URL that points to the portal servlet and it based on the navigational state of the current request.FriendlyURL newURL(ServerContext serverContext, URLContext allowedContext, Constants.Clone type)
Generates a URL based on the given server context.FriendlyURL newURL(URLContext allowedContext, Constants.Clone type)
Generates a URL that points to the portal servlet and it based on the navigational state of the current request.
Method Detail newURL
FriendlyURL newURL() throws StateException
- Generates a URL that points to the portal servlet and it based on the navigational state of the current request.
- Returns:
- A new FriendlyURL object. Not null.
- Throws:
- StateException - - if the URL could not be created
newURL
FriendlyURL newURL(Constants.Clone type) throws StateException
- Generates a URL that points to the portal servlet and it based on the navigational state of the current request.
- Parameters:
- type - Type of the clone operation to get a copy of the given StateHolder. May be null in which case a SMART_COPY will be generated.
- Returns:
- A new FriendlyURL object. Not null.
- Throws:
- StateException - - if the URL could not be created
newURL
FriendlyURL newURL(URLContext allowedContext, Constants.Clone type) throws StateException
- Generates a URL that points to the portal servlet and it based on the navigational state of the current request.
- Parameters:
- allowedContext - Specifies what type of URL may be generated. 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 given StateHolder. May be null in which case a SMART_COPY will be generated.
- Returns:
- A new FriendlyURL object. Not null.
- Throws:
- StateException - - if the URL could not be created
newURL
FriendlyURL newURL(ServerContext serverContext, URLContext allowedContext, Constants.Clone type) throws StateException
- Generates a URL based on the given server context. The URL will be based on the navigational state of the current request.
- Parameters:
- serverContext - Specifies the server information. Must not be null.
- allowedContext - Specifies what type of URL may be generated. 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 given StateHolder. May be null in which case a SMART_COPY will be generated.
- Returns:
- A new FriendlyURL object. Not null.
- Throws:
- StateException - - if the URL could not be created
getServerContext
ServerContext getServerContext()
- Returns information about the URL configuration in the scope of the current request.
- Specified by:
- getServerContext in interface ServerContextProvider
- Returns:
- the server context of the request, not null
- Since:
- 7.0
Tree PREV CLASS NEXT CLASS SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD