com.ibm.portal.outbound.config
Interface VirtualPortalScope

All Known Subinterfaces:

VirtualPortalScope.AnyVirtualPortalScope

All Known Implementing Classes:

VPScope

public interface VirtualPortalScope

The virtual portal scope. This interface identifies the virtual portal, for which an outbound HTTP connection
model is requested. A Virtual Portal can be identified by either

• a URL context, or
• a hostname

This interface is used by the method OutboundConnectionModelProvider#getOutboundConnectionModel(VirtualPortalScope).

Code example:

javax.naming.Context ctx = new javax.naming.InitialContext();
VirtualPortalScope vp = VPScope.byContextPath("myvirtual");
OutboundConnectionModelHome home = (OutboundConnectionModelHome) ctx.lookup("portal:service/model/OutboundConnectionModel");
OutboundConnectionModel model = home.getOutboundConnectionModelProvider().getOutboundConnectionModel(vp);


Since:

8.5.0

See Also:

com.ibm.portal.outbound.config.OutboundConnectionModelProvider, VPScope

Nested Class Summary

static interface

VirtualPortalScope.AnyVirtualPortalScope This interface is used to retrieve an outbound HTTP connection configuration model without any portal scoping.

Method Summary

java.lang.String	getVirtualPortalContextPath() Return the context path that identifies the virtual portal
java.lang.String	getVirtualPortalHostname() Return the host name that identifies the virtual portal

Method Detail

getVirtualPortalContextPath

java.lang.String getVirtualPortalContextPath()

Return the context path that identifies the virtual portal

Returns:

The context path of the virtual portal, The method returns null if either

• the scope identifies the root virtual portal, or
• the virtual portal is identified by host name

getVirtualPortalHostname

java.lang.String getVirtualPortalHostname()

Return the host name that identifies the virtual portal

Returns:

The host name of the virtual portal, The method returns null if either

• the scope identifies the root virtual portal, or
• the virtual portal is identified by a context path