org.jboss.portal.server
Class Portal

java.lang.Object
  org.jboss.portal.server.kernel.BaseService
      org.jboss.portal.server.ServerObject
          org.jboss.portal.server.Portal

All Implemented Interfaces:

PluginContainer, Registration, Service

Direct Known Subclasses:

CorePortal

public class Portal
extends ServerObject
implements PluginContainer

The portal state.

Field Summary

protected PortalMetaData	portalMD Our meta data.
protected PortalServer	portalServer Parent container.
protected java.util.Map	properties Portal properties
protected java.util.Map	windows Windows that have a relationship with that portal.

Fields inherited from class org.jboss.portal.server.ServerObject

log, name, plugins

Fields inherited from class org.jboss.portal.server.kernel.BaseService

ctx

Constructor Summary

Portal(PortalMetaData portalMD, java.lang.String name)

Method Summary

void	addDependsOnMe(ServiceImplementation implementation) Add a service depending on this one.
void	addIDependOn(ServiceImplementation implementation) Add a service it depends on.
ServerURL	createURL() Create a new URL for that will target this object.
ServerObjectMetaData	getMetaData() Return the meta data for that object.
ModeProvider	getModeProvider()
java.util.Map	getProperties()
PortalServer	getServer() Return the container this object belongs to.
Window	getWindow(java.lang.String name)
java.util.Collection	getWindows()
WindowStateProvider	getWindowStateProvider()
void	removeDependsOnMe(ServiceImplementation implementation) Remove a service depending on this one.
void	removeIDependOn(ServiceImplementation implementation) Remove a service it depends on.
void	start() Start.
void	stop() Stop.

Methods inherited from class org.jboss.portal.server.ServerObject

addPlugin, create, createContext, destroy, getID, getName, getPlugin, getPluginKeySet, invoke, removePlugin

Methods inherited from class org.jboss.portal.server.kernel.BaseService

registered, unregister

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.portal.common.plugin.PluginContainer

addPlugin, getPlugin, getPluginKeySet, removePlugin

Methods inherited from interface org.jboss.portal.server.kernel.Registration

registered, unregister

Field Detail

windows

protected java.util.Map windows

Windows that have a relationship with that portal.

portalServer

protected PortalServer portalServer

Parent container.

portalMD

protected PortalMetaData portalMD

Our meta data.

properties

protected java.util.Map properties

Portal properties

Constructor Detail

Portal

public Portal(PortalMetaData portalMD,
              java.lang.String name)

Method Detail

getMetaData

public ServerObjectMetaData getMetaData()

Description copied from class: ServerObject

Return the meta data for that object.

Specified by:

getMetaData in class ServerObject

getModeProvider

public ModeProvider getModeProvider()

getWindowStateProvider

public WindowStateProvider getWindowStateProvider()

start

public void start()
           throws java.lang.Exception

Description copied from interface: Service

Start.

Specified by:

start in interface Service

Overrides:

start in class ServerObject

Throws:

java.lang.Exception

stop

public void stop()

Description copied from interface: Service

Stop.

Specified by:

stop in interface Service

Overrides:

stop in class ServerObject

getServer

public PortalServer getServer()

Description copied from class: ServerObject

Return the container this object belongs to.

Specified by:

getServer in class ServerObject

getProperties

public java.util.Map getProperties()

getWindow

public Window getWindow(java.lang.String name)

getWindows

public java.util.Collection getWindows()

addIDependOn

public void addIDependOn(ServiceImplementation implementation)

Description copied from interface: Registration

Add a service it depends on.

Specified by:

addIDependOn in interface Registration

Overrides:

addIDependOn in class ServerObject

removeIDependOn

public void removeIDependOn(ServiceImplementation implementation)

Description copied from interface: Registration

Remove a service it depends on.

Specified by:

removeIDependOn in interface Registration

Overrides:

removeIDependOn in class ServerObject

addDependsOnMe

public void addDependsOnMe(ServiceImplementation implementation)

Description copied from interface: Registration

Add a service depending on this one.

Specified by:

addDependsOnMe in interface Registration

Overrides:

addDependsOnMe in class ServerObject

removeDependsOnMe

public void removeDependsOnMe(ServiceImplementation implementation)

Description copied from interface: Registration

Remove a service depending on this one.

Specified by:

removeDependsOnMe in interface Registration

Overrides:

removeDependsOnMe in class ServerObject

createURL

public ServerURL createURL()

Description copied from class: ServerObject

Create a new URL for that will target this object.

Overrides:

createURL in class ServerObject