|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.jetspeed.om.portlet.impl.PortletApplicationDefinitionImpl
public class PortletApplicationDefinitionImpl
Field Summary | |
---|---|
protected long |
webApplicationId
PK of this Portlet Application's Web Application |
Fields inherited from interface org.apache.jetspeed.om.common.portlet.MutablePortletApplication |
---|
INTERNAL, LOCAL, PREFS_ROOT, WEBAPP |
Constructor Summary | |
---|---|
PortletApplicationDefinitionImpl()
Creates a new instance of BaseApplication |
Method Summary | |
---|---|
void |
addCustomPortletMode(CustomPortletMode customPortletMode)
|
void |
addCustomWindowState(CustomWindowState customWindowState)
|
void |
addJetspeedService(JetspeedServiceReference service)
Adds a Jetspeed component service to the collection of component services allowed for this application. |
void |
addPortletDefinition(org.apache.pluto.om.portlet.PortletDefinition pd)
|
void |
addUserAttribute(java.lang.String userName,
java.lang.String description)
Adds a user attribute to the user attribute set. |
void |
addUserAttribute(UserAttribute userAttribute)
Adds a user attribute to the user attribute set. |
void |
addUserAttributeRef(UserAttributeRef userAttributeRef)
Adds a user attribute ref to the user attribute ref set. |
java.lang.String |
getApplicationIdentifier()
|
int |
getApplicationType()
Gets the Portlet Application type. |
long |
getChecksum()
The checksum on the portlet XML from the last deployment |
javax.portlet.PortletMode |
getCustomPortletMode(javax.portlet.PortletMode mode)
|
java.util.Collection |
getCustomPortletModes()
|
javax.portlet.WindowState |
getCustomWindowState(javax.portlet.WindowState state)
|
java.util.Collection |
getCustomWindowStates()
|
java.lang.String |
getDescription()
|
org.apache.pluto.om.common.ObjectID |
getId()
|
java.lang.String |
getJetspeedSecurityConstraint()
Get the Jetspeed Security Constraint reference for this portlet application. |
java.util.Collection |
getJetspeedServices()
Gets a collection of all Jetspeed Services allowed for this application. |
javax.portlet.PortletMode |
getMappedPortletMode(javax.portlet.PortletMode mode)
|
javax.portlet.WindowState |
getMappedWindowState(javax.portlet.WindowState state)
|
GenericMetadata |
getMetadata()
Returns the metadata from the extended jetspeed-portlet.xml |
protected java.util.Collection |
getMetadataFields()
|
java.lang.String |
getName()
Gets the name of the Portlet Application. |
org.apache.pluto.om.portlet.PortletDefinition |
getPortletDefinitionByName(java.lang.String name)
Finds a portlet by portlet name, searching this portlet application's collection. |
org.apache.pluto.om.portlet.PortletDefinitionList |
getPortletDefinitionList()
|
java.util.Collection |
getPortletDefinitions()
|
java.util.Collection |
getSupportedPortletModes()
|
java.util.Collection |
getSupportedWindowStates()
|
java.util.Collection |
getUserAttributeRefs()
Gets the collection of user attribute refs associated with this portlet application. |
java.util.Collection |
getUserAttributes()
Gets the collection of user attributes associated with this portlet application. |
java.lang.String |
getVersion()
|
org.apache.pluto.om.servlet.WebApplicationDefinition |
getWebApplicationDefinition()
|
boolean |
isLayoutApplication()
Returns true if the portlet application is a layout application Layouts are not "general" portlets, but instead used to group together other layouts and portlet fragments |
void |
postLoad(java.lang.Object parameter)
|
void |
setApplicationIdentifier(java.lang.String applicationIdentifier)
|
void |
setApplicationType(int type)
Sets the Portlet Application type. |
void |
setChecksum(long checksum)
The checksum on the portlet XML from the last deployment |
void |
setCustomPortletModes(java.util.Collection customPortletModes)
|
void |
setCustomWindowStates(java.util.Collection customWindowStates)
|
void |
setDescription(java.lang.String string)
|
void |
setJetspeedSecurityConstraint(java.lang.String constraint)
Set the Jetspeed Security Constraint reference for this portlet application. |
void |
setMetadata(GenericMetadata metadata)
Sets the metadata from the extended jetspeed-portlet.xml |
protected void |
setMetadataFields(java.util.Collection metadataFields)
|
void |
setName(java.lang.String name)
|
void |
setPortletDefinitionList(org.apache.pluto.om.portlet.PortletDefinitionList portlets)
|
void |
setUserAttributeRefs(java.util.Collection userAttributeRefs)
Sets a user-attribute-ref to the collection of user attribute refs associated with this portlet application. |
void |
setUserAttributes(java.util.Collection userAttributes)
Sets a user-attribute to the collection of user attributes associated with this portlet application. |
void |
setVersion(java.lang.String version)
|
void |
setWebApplicationDefinition(org.apache.pluto.om.servlet.WebApplicationDefinition wad)
Associates the web application definition with this portlet application defintion. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected long webApplicationId
Constructor Detail |
---|
public PortletApplicationDefinitionImpl()
Method Detail |
---|
public org.apache.pluto.om.common.ObjectID getId()
getId
in interface org.apache.pluto.om.portlet.PortletApplicationDefinition
PortletApplicationDefinition.getId()
public java.lang.String getName()
PortletApplication
getName
in interface PortletApplication
org.apache.jetspeed.om.common.Application#getName()
public void setName(java.lang.String name)
setName
in interface MutablePortletApplication
org.apache.jetspeed.om.common.Application#setName(String)
public java.lang.String getVersion()
getVersion
in interface org.apache.pluto.om.portlet.PortletApplicationDefinition
org.apache.jetspeed.om.common.Application#getVersion()
public void setVersion(java.lang.String version)
setVersion
in interface MutablePortletApplication
org.apache.jetspeed.om.common.Application#setVersion(String)
public org.apache.pluto.om.servlet.WebApplicationDefinition getWebApplicationDefinition()
getWebApplicationDefinition
in interface org.apache.pluto.om.portlet.PortletApplicationDefinition
public org.apache.pluto.om.portlet.PortletDefinitionList getPortletDefinitionList()
getPortletDefinitionList
in interface org.apache.pluto.om.portlet.PortletApplicationDefinition
PortletApplicationDefinition.getPortletDefinitionList()
public java.lang.String getDescription()
getDescription
in interface PortletApplication
public void setDescription(java.lang.String string)
setDescription
in interface MutablePortletApplication
string
- public void setWebApplicationDefinition(org.apache.pluto.om.servlet.WebApplicationDefinition wad)
MutablePortletApplication
setWebApplicationDefinition
in interface MutablePortletApplication
MutablePortletApplication.setWebApplicationDefinition(org.apache.pluto.om.servlet.WebApplicationDefinition)
public void addPortletDefinition(org.apache.pluto.om.portlet.PortletDefinition pd)
addPortletDefinition
in interface MutablePortletApplication
MutablePortletApplication.addPortletDefinition(org.apache.pluto.om.portlet.PortletDefinition)
public java.util.Collection getPortletDefinitions()
getPortletDefinitions
in interface PortletApplication
PortletApplication.getPortletDefinitions()
public org.apache.pluto.om.portlet.PortletDefinition getPortletDefinitionByName(java.lang.String name)
PortletApplication
getPortletDefinitionByName
in interface PortletApplication
name
- The portlet name.
PortletApplication.getPortletDefinitionByName(java.lang.String)
public void setPortletDefinitionList(org.apache.pluto.om.portlet.PortletDefinitionList portlets)
setPortletDefinitionList
in interface MutablePortletApplication
MutablePortletApplication.setPortletDefinitionList(org.apache.pluto.om.portlet.PortletDefinitionList)
public void setUserAttributeRefs(java.util.Collection userAttributeRefs)
MutablePortletApplication
Sets a user-attribute-ref to the collection of user attribute refs associated with this portlet application.
setUserAttributeRefs
in interface MutablePortletApplication
MutablePortletApplication.setUserAttributeRefs(java.util.Collection)
public java.util.Collection getUserAttributeRefs()
PortletApplication
Gets the collection of user attribute refs associated with this portlet application.
getUserAttributeRefs
in interface PortletApplication
PortletApplication.getUserAttributeRefs()
public void addUserAttributeRef(UserAttributeRef userAttributeRef)
MutablePortletApplication
Adds a user attribute ref to the user attribute ref set.
addUserAttributeRef
in interface MutablePortletApplication
userAttributeRef
- The user attribute ref.MutablePortletApplication.addUserAttributeRef(org.apache.jetspeed.om.common.UserAttributeRef)
public void addUserAttribute(UserAttribute userAttribute)
MutablePortletApplication
Adds a user attribute to the user attribute set.
addUserAttribute
in interface MutablePortletApplication
userAttribute
- The user attribute.MutablePortletApplication.addUserAttribute(org.apache.jetspeed.om.common.UserAttribute)
public void addUserAttribute(java.lang.String userName, java.lang.String description)
MutablePortletApplication
Adds a user attribute to the user attribute set.
addUserAttribute
in interface MutablePortletApplication
MutablePortletApplication.addUserAttribute(java.lang.String, java.lang.String)
public void setUserAttributes(java.util.Collection userAttributes)
MutablePortletApplication
Sets a user-attribute to the collection of user attributes associated with this portlet application.
setUserAttributes
in interface MutablePortletApplication
MutablePortletApplication.setUserAttributes(java.util.Collection)
public java.util.Collection getUserAttributes()
PortletApplication
Gets the collection of user attributes associated with this portlet application.
getUserAttributes
in interface PortletApplication
PortletApplication.getUserAttributes()
public void setApplicationIdentifier(java.lang.String applicationIdentifier)
setApplicationIdentifier
in interface MutablePortletApplication
MutablePortletApplication.setApplicationIdentifier(java.lang.String)
public java.lang.String getApplicationIdentifier()
getApplicationIdentifier
in interface PortletApplication
PortletApplication.getApplicationIdentifier()
public void setApplicationType(int type)
MutablePortletApplication
MutablePortletApplication.WEBAPP
- A standard web application, stored in the web application
server's web application space.
MutablePortletApplication.LOCAL
- A local portlet application stored within Jetspeed's web application.
setApplicationType
in interface MutablePortletApplication
type
- The type of portlet application.MutablePortletApplication.setApplicationType(int)
public int getApplicationType()
PortletApplication
MutablePortletApplication.WEBAPP
- A standard web application, stored in the web application
server's web application space.
MutablePortletApplication.LOCAL
- A local portlet application stored within Jetspeed's web application.
getApplicationType
in interface PortletApplication
PortletApplication.getApplicationType()
public GenericMetadata getMetadata()
PortletApplication
getMetadata
in interface PortletApplication
PortletApplication.getMetadata()
public void setMetadata(GenericMetadata metadata)
MutablePortletApplication
setMetadata
in interface MutablePortletApplication
MutablePortletApplication.setMetadata(org.apache.jetspeed.om.common.GenericMetadata)
protected java.util.Collection getMetadataFields()
protected void setMetadataFields(java.util.Collection metadataFields)
collection
- public java.util.Collection getJetspeedServices()
PortletApplication
getJetspeedServices
in interface PortletApplication
JetspeedServiceReference
.JetspeedServiceReference
public void addJetspeedService(JetspeedServiceReference service)
MutablePortletApplication
addJetspeedService
in interface MutablePortletApplication
service
- The component service being added.public long getChecksum()
MutablePortletApplication
getChecksum
in interface MutablePortletApplication
public void setChecksum(long checksum)
MutablePortletApplication
setChecksum
in interface MutablePortletApplication
public void postLoad(java.lang.Object parameter) throws java.lang.Exception
postLoad
in interface Support
java.lang.Exception
public java.util.Collection getCustomPortletModes()
getCustomPortletModes
in interface PortletApplication
public void addCustomPortletMode(CustomPortletMode customPortletMode)
public void setCustomPortletModes(java.util.Collection customPortletModes)
public javax.portlet.PortletMode getMappedPortletMode(javax.portlet.PortletMode mode)
getMappedPortletMode
in interface PortletApplication
public javax.portlet.PortletMode getCustomPortletMode(javax.portlet.PortletMode mode)
getCustomPortletMode
in interface PortletApplication
public java.util.Collection getSupportedPortletModes()
getSupportedPortletModes
in interface PortletApplication
public java.util.Collection getCustomWindowStates()
getCustomWindowStates
in interface PortletApplication
public void addCustomWindowState(CustomWindowState customWindowState)
public void setCustomWindowStates(java.util.Collection customWindowStates)
public javax.portlet.WindowState getMappedWindowState(javax.portlet.WindowState state)
getMappedWindowState
in interface PortletApplication
public javax.portlet.WindowState getCustomWindowState(javax.portlet.WindowState state)
getCustomWindowState
in interface PortletApplication
public java.util.Collection getSupportedWindowStates()
getSupportedWindowStates
in interface PortletApplication
public java.lang.String getJetspeedSecurityConstraint()
PortletApplication
Get the Jetspeed Security Constraint reference for this portlet application. This security constraint name references a Jetspeed-specific Security Constraint. Security Constraints are not Java Security Permissions, but a Jetspeed specific way of securing portlets, also known as PSML constraints. See the page.security file for examples of defining security constraint definitions. If a Jetspeed Security Constraint is not defined for a portlet, the constraint applied will then fallback to the constraint defined for the portlet application. If the portlet application does not define a constraint, then no security constraints will be applied to this portlet. Security constraints for a portlet are normally checking during the render process of a portlet.
getJetspeedSecurityConstraint
in interface PortletApplication
public void setJetspeedSecurityConstraint(java.lang.String constraint)
MutablePortletApplication
Set the Jetspeed Security Constraint reference for this portlet application. This security constraint name references a Jetspeed-specific Security Constraint. Security Constraints are not Java Security Permissions, but a Jetspeed specific way of securing portlets, also known as PSML constraints. See the page.security file for examples of defining security constraint definitions. If the portlet application does not define a constraint, then no security constraints will be applied to this portlet. Security constraints for a portlet are normally checking during the render process of a portlet.
setJetspeedSecurityConstraint
in interface MutablePortletApplication
constraint
- The name of the Security Definition defined in
the Jetspeed Security Constraintspublic boolean isLayoutApplication()
PortletApplication
isLayoutApplication
in interface PortletApplication
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |