org.jboss.portal.core.impl.model.instance
Class AbstractInstance

java.lang.Object
  extended by org.jboss.portal.core.impl.model.instance.AbstractInstance
All Implemented Interfaces:
Instance
Direct Known Subclasses:
AbstractInstanceCustomization, AbstractInstanceDefinition

public abstract class AbstractInstance
extends java.lang.Object
implements Instance

Version:
$Revision: 1.1 $
Author:
Julien Viet

Field Summary
protected  PortletContext portletContext
          Composite representation of portletRef + state.
protected  java.lang.String portletRef
          .
protected  byte[] state
          .
 
Fields inherited from interface org.jboss.portal.core.model.instance.Instance
INSTANCE_ID_ATTRIBUTE
 
Constructor Summary
protected AbstractInstance()
           
 
Method Summary
protected abstract  void cloned(PortletContext portletContext)
           
 void destroyCustomization(java.lang.String customizationId)
          Destroy the customization
protected abstract  AccessMode getAccessMode()
           
 InstanceContainer getContainer()
          Return the container of this object.
protected abstract  InstanceContainerContext getContainerContext()
           
 InstanceCustomization getCustomization(java.lang.String customizationId)
          Return a customization of this instance related to the provided customization id.
 InstanceDefinition getDefinition()
           
protected abstract  java.lang.String getInstanceId()
           
protected abstract  Logger getLogger()
           
protected abstract  AbstractInstanceDefinition getOwner()
           
 Portlet getPortlet()
          Return the runtime metadata for this portlet.
 PortletContext getPortletContext()
           
 java.lang.String getPortletRef()
           
 PropertyMap getProperties()
          Return the instance preferences.
 PropertyMap getProperties(java.util.Set keys)
          Return the instance preferences.
 byte[] getState()
           
 PortletInvocationResponse invoke(PortletInvocation invocation)
          Invoke the instance
 boolean isModifiable()
           
protected abstract  boolean isMutable()
           
protected  void modified(PortletContext portletContext)
           
protected abstract  void setMutable(boolean modifiable)
           
 void setPortletRef(java.lang.String portletRef)
           
 void setProperties(PropertyChange[] changes)
          Update the prefs of this instance.
 void setState(byte[] state)
           
 
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.core.model.instance.Instance
getId
 

Field Detail

portletRef

protected java.lang.String portletRef
.


state

protected byte[] state
.


portletContext

protected PortletContext portletContext
Composite representation of portletRef + state.

Constructor Detail

AbstractInstance

protected AbstractInstance()
Method Detail

getPortletRef

public java.lang.String getPortletRef()

setPortletRef

public void setPortletRef(java.lang.String portletRef)

getState

public byte[] getState()

setState

public void setState(byte[] state)

getPortletContext

public final PortletContext getPortletContext()

isModifiable

public final boolean isModifiable()

isMutable

protected abstract boolean isMutable()

setMutable

protected abstract void setMutable(boolean modifiable)

getLogger

protected abstract Logger getLogger()

getAccessMode

protected abstract AccessMode getAccessMode()

cloned

protected abstract void cloned(PortletContext portletContext)

getOwner

protected abstract AbstractInstanceDefinition getOwner()

getContainerContext

protected abstract InstanceContainerContext getContainerContext()

getInstanceId

protected abstract java.lang.String getInstanceId()

modified

protected final void modified(PortletContext portletContext)

getDefinition

public final InstanceDefinition getDefinition()

getPortlet

public final Portlet getPortlet()
                         throws PortletInvokerException
Description copied from interface: Instance
Return the runtime metadata for this portlet.

Specified by:
getPortlet in interface Instance
Returns:
the info
Throws:
PortletInvokerException

getContainer

public final InstanceContainer getContainer()
Description copied from interface: Instance
Return the container of this object.

Specified by:
getContainer in interface Instance
Returns:
the instance container

setProperties

public final void setProperties(PropertyChange[] changes)
                         throws PortletInvokerException
Description copied from interface: Instance
Update the prefs of this instance.

Specified by:
setProperties in interface Instance
Parameters:
changes - the changes
Throws:
PortletInvokerException

getProperties

public final PropertyMap getProperties()
                                throws PortletInvokerException
Description copied from interface: Instance
Return the instance preferences.

Specified by:
getProperties in interface Instance
Returns:
the prefs
Throws:
PortletInvokerException

getProperties

public final PropertyMap getProperties(java.util.Set keys)
                                throws PortletInvokerException
Description copied from interface: Instance
Return the instance preferences.

Specified by:
getProperties in interface Instance
Returns:
the prefs
Throws:
PortletInvokerException

invoke

public final PortletInvocationResponse invoke(PortletInvocation invocation)
                                       throws PortletInvokerException
Description copied from interface: Instance
Invoke the instance

Specified by:
invoke in interface Instance
Parameters:
invocation - the invocation
Throws:
PortletInvokerException

getCustomization

public final InstanceCustomization getCustomization(java.lang.String customizationId)
Description copied from interface: Instance
Return a customization of this instance related to the provided customization id.

Specified by:
getCustomization in interface Instance
Returns:
an instance customization

destroyCustomization

public final void destroyCustomization(java.lang.String customizationId)
Description copied from interface: Instance
Destroy the customization

Specified by:
destroyCustomization in interface Instance
Parameters:
customizationId - the id of the customization to destroy