com.ibm.portal.vanityurl.model
Interface ModifiableVanityURLNode

All Superinterfaces:

Identifiable, Modifiable, VanityURLNode

public interface ModifiableVanityURLNode
extends VanityURLNode, Modifiable

This is the writable interface for vanity URLs. Instances can be obtained from the VanityURLModelController. If no port is specified PORTAL_DEFAULT_PORT is used.

Since:

8.5

Field Summary

Fields inherited from interface com.ibm.portal.vanityurl.model.VanityURLNode

PORTAL_DEFAULT_PORT, PROTOCOL_DEFAULT_PORT, REQUEST_PORT

Method Summary

void	copyStateFrom(StateHolder state) The passed in state will be copied and the caller can dispose the object.
void	setHostName(java.lang.String hostName) Sets the host name this vanity URL shall be mapped to.
void	setPageId(ObjectID pageId) Sets the target page this vanity URL shall redirect to.
void	setPath(java.lang.String path) Sets the path this vanity URL shall be registered for.
void	setPort(int port) The specified port must be between 1 and 65535 (inclusive) or one of the special values (see below).
void	setProtected(java.lang.Boolean flag) Sets the protection mode for the redirection.
void	setSecure(java.lang.Boolean flag) Sets the connection security mode for the redirect.

Methods inherited from interface com.ibm.portal.vanityurl.model.VanityURLNode

getHost, getPageId, getPath, getPort, getState, getVpId, isProtected, isSecure

Methods inherited from interface com.ibm.portal.Identifiable

getObjectID

Method Detail

setHostName

void setHostName(java.lang.String hostName)
                 throws ModelException

Sets the host name this vanity URL shall be mapped to.

Parameters:

hostName - the host name this vanity URL shall be mapped to

Throws:

ModelException - if the specified host name could not be set

setPort

void setPort(int port)
             throws ModelException

The specified port must be between 1 and 65535 (inclusive) or one of the special values (see below).

Parameters:

port - the port that should be used for the redirect of this vanity URL

Throws:

ModelException - if the specified port could not be set

See Also:

com.ibm.portal.vanityurl.model.VanityURLNode.PROTOCOL_DEFAULT_PORT, com.ibm.portal.vanityurl.model.VanityURLNode.PORTAL_DEFAULT_PORT, com.ibm.portal.vanityurl.model.VanityURLNode.REQUEST_PORT

setPath

void setPath(java.lang.String path)
             throws ModelException

Sets the path this vanity URL shall be registered for. This is the plain not escaped path without leading slash. An empty path or one with leading or trailing blanks is not allowed.

Parameters:

path - the new vanity URL path, can be null

Throws:

ModelException - if the specified path could not be set

setPageId

void setPageId(ObjectID pageId)
               throws ModelException

Sets the target page this vanity URL shall redirect to.

Parameters:

pageId - the ObjectID of the target page, must not be null

Throws:

ModelException - the the specified page could not be set

copyStateFrom

void copyStateFrom(StateHolder state)
                   throws ModelException

The passed in state will be copied and the caller can dispose the object.

Parameters:

state - the new state

Throws:

ModelException - if the state could not be set

setSecure

void setSecure(java.lang.Boolean flag)
               throws ModelException

Sets the connection security mode for the redirect.

Parameters:

flag - the new security mode

Throws:

ModelException - if the specified security mode could not be set

setProtected

void setProtected(java.lang.Boolean flag)
                  throws ModelException

Sets the protection mode for the redirection.

Parameters:

flag - the new protection mode

Throws:

ModelException - if the specified protection mode could not be set