public interface Definition
Modifier and Type | Interface and Description |
---|---|
static class |
Definition.AppType
This object defines the Content Server app type for which the URI should be constructed.
|
static class |
Definition.ContainerType
This object defines the containers for which a URI can be defined.
|
static class |
Definition.SatelliteContext
Class to define the satellite context of the URI.
|
Modifier and Type | Field and Description |
---|---|
static String |
LOG_NAME
Logger name, for use with Jakarta Commons Logging.
|
Modifier and Type | Method and Description |
---|---|
Definition.AppType |
getAppType()
Returns the app type for which this URI is to be generated.
|
Collection |
getAttrbuteNames()
Returns the keys of all the attributes.
|
Object |
getAttribute(String key)
Return an attribute with the given key.
|
String |
getAuthority()
Returns the authority for this URI.
|
Definition.ContainerType |
getContainerType()
Returns the container type for which this URI is to be generated.
|
String |
getFragment()
Returns a fragment identifier for this URI.
|
String |
getParameter(String name)
Return a single parameter with the given name.
|
Collection |
getParameterNames()
Returns the names of all the parameters.
|
String[] |
getParameters(String name)
Returns an array of parameters with the given name.
|
Definition.SatelliteContext |
getSatelliteContext()
Returns an object describing whether the URI should be set to render a Satellite Server URL or a Content Server URL.
|
String |
getScheme()
Returns the scheme for this URI.
|
boolean |
sessionEncode()
Returns true if this URI should be session-encoded by the container.
|
static final String LOG_NAME
log
, Constant Field ValuesString getScheme()
http
and https.URI.getScheme()
String getAuthority()
URI.getAuthority()
Definition.ContainerType getContainerType()
Definition.ContainerType.DEFAULT
which allows the current container to be used, however when switching container types is important, this method should return a different value. An example might be a popup window in a portlet.Definition.AppType getAppType()
String getParameter(String name)
name
- parameter nameString[] getParameters(String name)
name
- parameter nameObject getAttribute(String key)
key
- attribute keyCollection getAttrbuteNames()
Collection getParameterNames()
String getFragment()
boolean sessionEncode()
Definition.SatelliteContext getSatelliteContext()