atg.portal.framework
Class PortalManager

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.portal.framework.PortalManager

All Implemented Interfaces:

atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class PortalManager
extends GenericService

Root-level access methods for the Portal API.

Field Summary

static java.lang.String

CLASS_VERSION

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

PortalManager()

Method Summary

void	addPortal(Portal pPortal) Adds a portal to the collection of active portals.
Portal	getDefaultPortal() Returns the default portal instance.
Portal	getPortalById(java.lang.String pId) Retrieves the portal with the indicated ID, if any.
Portal[]	getPortalInstances() Returns an array of portal instances managed by this portal manager.
static PortalManager	getPortalManager() Looks up the portal manager instance.
PortalObjectResolver	getPortalObjectResolver() Retrieves the portal object resolver that is used to translate an HTTP request into the portal objects it refers to.
java.util.Set	getPortalSet() Retrieves the root-level Portal objects that the user can see.
void	removePortal(Portal pPortal) Removes a portal from the collection of active portals.
void	setDefaultPortal(Portal pPortal) Changes the default portal instance.
void	setPortalInstances(Portal[] pPortals) Changes the list of portal instances managed by this portal manager.
void	setPortalObjectResolver(PortalObjectResolver pResolver) Changes the portal object resolver that is used to translate an HTTP request into the portal objects it refers to.

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Constructor Detail

PortalManager

public PortalManager()

Method Detail

getPortalManager

public static PortalManager getPortalManager()

Looks up the portal manager instance.

getDefaultPortal

public Portal getDefaultPortal()

Returns the default portal instance.

setDefaultPortal

public void setDefaultPortal(Portal pPortal)

Changes the default portal instance.

getPortalInstances

public Portal[] getPortalInstances()

Returns an array of portal instances managed by this portal manager. This is used for configuration purposes; it is not a supported API.

setPortalInstances

public void setPortalInstances(Portal[] pPortals)

Changes the list of portal instances managed by this portal manager.

setPortalObjectResolver

public void setPortalObjectResolver(PortalObjectResolver pResolver)

Changes the portal object resolver that is used to translate an HTTP request into the portal objects it refers to.

getPortalObjectResolver

public PortalObjectResolver getPortalObjectResolver()

Retrieves the portal object resolver that is used to translate an HTTP request into the portal objects it refers to.

addPortal

public void addPortal(Portal pPortal)

Adds a portal to the collection of active portals.

removePortal

public void removePortal(Portal pPortal)

Removes a portal from the collection of active portals.

getPortalSet

public java.util.Set getPortalSet()

Retrieves the root-level Portal objects that the user can see.

getPortalById

public Portal getPortalById(java.lang.String pId)

Retrieves the portal with the indicated ID, if any.