Tree PREV CLASS NEXT CLASS SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD com.ibm.portal.vanityurl.model
Interface VanityURLNode
- All Superinterfaces:
- Identifiable
- All Known Subinterfaces:
- ModifiableVanityURLNode
public interface VanityURLNode- extends Identifiable
Interface of a vanity URL node. Instances of this interface can be obtained from a VanityURLModel. This is a read only interface. To modify a vanity URL you need to obtain a ModifiableVanityURLNode using a VanityURLModelController.
- Since:
- 8.5
Field Summary static int PORTAL_DEFAULT_PORT
Use the port that is defined as the default in WebSphere Portal.static int PROTOCOL_DEFAULT_PORT
Use the protocol's default port.static int REQUEST_PORT
Use the port that the request was made on.
Method Summary java.lang.String getHost()
The host name this vanity URL is registered for.ObjectID getPageId()
The ObjectID of the page this vanity URL is registered for.java.lang.String getPath()
The path the vanity URL is registered for.int getPort()
The port this vanity URL is registered for.StateHolder getState()
The target navigational state for the vanity URL redirect.ObjectID getVpId()
Return the ObjectID of the virtual portal this vanity URL is refering to.java.lang.Boolean isProtected()
TRUE, if the redirection shall be done to the protected version of the page.java.lang.Boolean isSecure()
TRUE, if the redirect to the target page shall enforce the use of a secure connection.
Methods inherited from interface com.ibm.portal.Identifiable getObjectID
Field Detail PROTOCOL_DEFAULT_PORT
static final int PROTOCOL_DEFAULT_PORT
- Use the protocol's default port.
- See Also:
- Constant Field Values
PORTAL_DEFAULT_PORT
static final int PORTAL_DEFAULT_PORT
- Use the port that is defined as the default in WebSphere Portal. This is the default when creating a new VanityURLNode.
- See Also:
- Constant Field Values
REQUEST_PORT
static final int REQUEST_PORT
- Use the port that the request was made on. In case a protocol switch needs to be done use the Portal default.
- See Also:
- Constant Field Values
Method Detail getVpId
ObjectID getVpId() throws ModelException
- Returns the ObjectID of the virtual portal this vanity URL is refering to.
- Returns:
- the virtual portal's ObjectID, never null
- Throws:
- ModelException - in case the data could not be retrieved
getHost
java.lang.String getHost() throws ModelException
- The host name this vanity URL is registered for.
- Returns:
- the host name or null if the vanity URL is not registered for a specific host
- Throws:
- ModelException - in case the data could not be retrieved
getPort
int getPort() throws ModelException
- The port this vanity URL is registered for.
- Returns:
- the port or one of the special values PROTOCOL_DEFAULT_PORT, PORTAL_DEFAULT_PORT or REQUEST_PORT
- Throws:
- ModelException - in case the data could not be retrieved
getPath
java.lang.String getPath() throws ModelException
- The path the vanity URL is registered for.
- Returns:
- the path, must not be null
- Throws:
- ModelException - in case the data could not be retrieved
getPageId
ObjectID getPageId() throws ModelException
- The ObjectID of the page this vanity URL is registered for. This is the page a user will get redirected to if the vanity URL is requested.
- Returns:
- the ObjectID of the target page, must not be null
- Throws:
- ModelException - in case the data could not be retrieved
getState
StateHolder getState() throws ModelException
- The target navigational state for the vanity URL redirect.
- Returns:
- the target state
- Throws:
- ModelException - in case the data could not be retrieved
isSecure
java.lang.Boolean isSecure() throws ModelException
- TRUE, if the redirect to the target page shall enforce the use of a secure connection. null indicates that the current state shall be used.
- Returns:
- TRUE, if a secure connection (like HTTPS) shall be used, can be null
- Throws:
- ModelException - in case the data could not be retrieved
isProtected
java.lang.Boolean isProtected() throws ModelException
- TRUE, if the redirection shall be done to the protected version of the page. null indicates that the the protected version shall be used if the user is already authenticated.
- Returns:
- the protection mode, can be null
- Throws:
- ModelException - in case the data could not be retrieved
Tree PREV CLASS NEXT CLASS SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD