com.ibm.portal.virtualportal
Interface VirtualPortalIdentification

public interface VirtualPortalIdentification

This interface can be used to identify the current virtual portal. During request processing, at some point, the request is parsed for the virtual portal it should be assigned to. This is usually done when processing the filter chain of a request in the filter "URLAnalyzer". For all steps performed after the filter "URLAnalyzer", usually, the virtual portal ID is correctly set. In case the request applies to the non-default virtual portal, the correct setting of the virtual portal ID can be checked with the method "isVirtualPortalIDSet()".

Since:

8.5 CF 10

Field Summary

static java.lang.String

JNDI_NAME JNDI name of this service

Method Summary

ObjectID	getVirtualPortalID() Returns the Virtual Portal ID of the current session.
boolean	isVirtualPortalIDSet() Returns true, if a VirtualPortal ID other than the default virtual portal ID has been set during request processing.

Field Detail

JNDI_NAME

static final java.lang.String JNDI_NAME

JNDI name of this service

See Also:

Constant Field Values

Method Detail

isVirtualPortalIDSet

boolean isVirtualPortalIDSet()

Returns true, if a VirtualPortal ID other than the default virtual portal ID has been set during request processing. Returns false if a VirtualPortal ID has not yet been set or if the request is processed by the default virtual portal.

Returns:

boolean, true - VirtualPortalID has been set, false - no VirtualPortalID set

getVirtualPortalID

ObjectID getVirtualPortalID()

Returns the Virtual Portal ID of the current session. If this method is called for a request before the the virtual portal of this request has been identified and set, this method returns the Virtual Portal ID of the default virtual portal. That means this method never returns a null value.

Returns:

Virtual Portal ID