|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.waveset.object.PersistentObject
com.waveset.object.Service
com.waveset.object.Application
An object used to represent a named collection of Resource objects.
These provide an alternative way to specify resources for a role in environments that are more aware of specific web applications than resources. // *
// * Hmm, should Applications contain any Service objects rather than // * just Resources? That might be handy.
Nested Class Summary |
Nested classes inherited from class com.waveset.object.PersistentObject |
PersistentObject.Comparator, PersistentObject.InitialInstance |
Field Summary | |
static java.lang.String |
ATT_OPAQUE
|
static java.lang.String |
ATT_ORDERED
|
static java.lang.String |
code_id
|
static java.lang.String |
EL_AUTHENTICATOR
|
static java.lang.String |
EL_RESOURCES
|
static java.lang.String |
EL_ROLEATTRIBUTES
|
static java.lang.String |
EL_ROLEEXCLUSIONREFS
|
static java.lang.String |
EL_SERVICES
XML markup. |
Fields inherited from class com.waveset.object.PersistentObject |
_trace, trace |
Constructor Summary | |
Application()
Construct a new empty application. |
|
Application(org.w3c.dom.Element e)
Deserialize an Application object from XML. |
Method Summary | |
void |
addResource(ObjectRef r)
Adds a resource to the application. |
void |
addResource(Resource r)
Add a new resource to the application. |
void |
addRoleAttribute(RoleAttribute ra)
|
void |
addRoleExclusionRef(ObjectRef or)
|
void |
addService(ObjectRef r)
Adds a service reference to the application. |
void |
addService(Service s)
Add a new service to the application. |
protected void |
addSubclassAttributes(java.lang.StringBuffer b)
Each concrete subclass may append to the buffer an XML representation of any fields it adds to PersistentObject (if those field values must persist). |
protected void |
addSubclassElements(java.lang.StringBuffer b)
Each concrete subclass may append to the buffer an XML representation of any fields it adds to PersistentObject (if those field values must persist). |
void |
clearResources()
Removes all resources from the application. |
void |
clearRoleAttributes()
|
void |
clearRoleExclusionRefs(java.util.List list)
|
void |
clearServices()
Removes all services from the application. |
int |
compareTo(java.lang.Object o)
Implement Comparable |
java.util.List |
getApplicationRefs()
Gets the list of applications references in this application. |
protected WSAttribute |
getAttributeValues(java.lang.String attrName)
|
ObjectRef |
getAuthenticatorRef()
|
java.util.ArrayList |
getReferences()
Return the list of references within this object. |
java.util.Set |
getResourceAssignmentRefs()
Gets the list of resource references in this application. |
java.util.Set |
getResourceAssignments()
Return the set of ResourceAssignments encapsulated by this Service and any Services it contains. |
java.util.List |
getResourceRefs()
Gets the list of resource references in this application. |
Resource[] |
getResources()
Gets an array of resolved Resource objects referenced by the application. |
java.util.List |
getRoleAttributes()
|
java.util.List |
getRoleExclusionRefs()
|
java.util.List |
getServiceRefs()
Return the master list of Service object references. |
Service[] |
getServices()
Return a resolved list of Service objects immediately referenced by this object. |
WSAttributes |
getSummaryAttributes()
|
Type |
getType()
Return the Type object associated with this class, which will always be Type.APPLICATION. |
boolean |
isOpaque()
Test the opaque flag. |
boolean |
isOrdered()
Override this if this service is a container and order is important. |
java.util.List |
listQueryableAttributes()
|
java.util.List |
listQueryableReferenceAttributes()
|
java.util.List |
listSummaryAttributes()
Returns the complete list of defined attributes
that this type of persistent object exposes as summary attributes
(regardless of whether this particular object has a value for each). |
protected void |
parseSubclassAttributes(org.w3c.dom.Element e)
Each concrete subclass should parse from the XML buffer any persisted subclass-specific fields (generally, the same ones that it writes into the buffer). |
protected void |
parseSubclassElements(org.w3c.dom.Element e)
Each concrete subclass should parse from the XML buffer any persisted subclass-specific elements (generally, the same ones that it writes into the buffer). |
void |
removeResource(ObjectRef ref)
Removes a resource reference. |
void |
removeResource(Resource r)
Removes a resource reference. |
void |
removeService(ObjectRef ref)
Removes a service reference. |
void |
removeService(Service s)
Removes a service reference. |
static void |
resolveSummaryAttributes(ObjectCache cache,
WSAttributes attrs)
Walk the summary attributes, translating the embedded IDs to names. |
void |
setAuthenticator(ObjectRef ref)
|
void |
setOpaque(boolean b)
|
void |
setOrdered(boolean b)
|
void |
setRoleAttributes(java.util.List list)
|
void |
setRoleExclusionRefs(java.util.List list)
|
void |
visit(Visitor v)
Visitor interface. |
Methods inherited from class com.waveset.object.Service |
checkForReferenceCycles, dumpSummary, findApplications, findApplications, findResourceAssignments, findResources, findRoleAttributes, findRoleExclusions, findRoles, findRoles, findServices, findServices, getFlatResourceAssignments, getFlatResourceAssignments, getFlatResources, getFlatResources, getFlatResources, getFlatResources, toIdentityString, toVerboseString, toVerboseString |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String code_id
public static final java.lang.String EL_SERVICES
public static final java.lang.String EL_RESOURCES
public static final java.lang.String EL_AUTHENTICATOR
public static final java.lang.String EL_ROLEATTRIBUTES
public static final java.lang.String EL_ROLEEXCLUSIONREFS
public static final java.lang.String ATT_OPAQUE
public static final java.lang.String ATT_ORDERED
Constructor Detail |
public Application()
public Application(org.w3c.dom.Element e) throws WavesetException
Normally, this will only be called by
PersistentObject.create()
.
Method Detail |
public Type getType()
getType
in class PersistentObject
public java.util.ArrayList getReferences()
getReferences
in class PersistentObject
public void visit(Visitor v) throws WavesetException
visit
in class PersistentObject
WavesetException
public java.util.List getServiceRefs()
getServiceRefs
in class Service
public Service[] getServices() throws WavesetException
getServices
in class Service
WavesetException
public void addService(Service s)
public void addService(ObjectRef r)
public void removeService(Service s)
The reference is specified as a Service object.
public void removeService(ObjectRef ref)
public void clearServices()
public void addResource(Resource r)
public void addResource(ObjectRef r)
public void removeResource(Resource r)
public void removeResource(ObjectRef ref)
public void clearResources()
public boolean isOpaque()
public void setOpaque(boolean b)
public boolean isOrdered()
Service
isOrdered
in class Service
public void setOrdered(boolean b)
public ObjectRef getAuthenticatorRef()
public void setAuthenticator(ObjectRef ref)
public java.util.List getRoleAttributes()
public void setRoleAttributes(java.util.List list)
public void clearRoleAttributes()
public void addRoleAttribute(RoleAttribute ra)
public java.util.List getRoleExclusionRefs()
public void setRoleExclusionRefs(java.util.List list)
public void clearRoleExclusionRefs(java.util.List list)
public void addRoleExclusionRef(ObjectRef or)
public java.util.List getResourceRefs() throws WavesetException
getResourceRefs
in class Service
WavesetException
public java.util.Set getResourceAssignmentRefs() throws WavesetException
getResourceAssignmentRefs
in class Service
WavesetException
public java.util.List getApplicationRefs() throws WavesetException
WavesetException
public Resource[] getResources() throws WavesetException
getResources
in class Service
WavesetException
public java.util.Set getResourceAssignments() throws WavesetException
Service
getResourceAssignments
in class Service
WavesetException
protected void addSubclassAttributes(java.lang.StringBuffer b)
PersistentObject
NOTE: Any subclass that overrides this method must similarly override parseSubclassAttributes() so that the subclass attributes are restored.
addSubclassAttributes
in class PersistentObject
protected void addSubclassElements(java.lang.StringBuffer b)
PersistentObject
NOTE: Any subclass that overrides this method must similarly override parseSubclassElements() so that the subclass elements are restored.
addSubclassElements
in class PersistentObject
protected void parseSubclassAttributes(org.w3c.dom.Element e) throws WavesetException
PersistentObject
parseSubclassAttributes
in class PersistentObject
WavesetException
PersistentObject's default implementation is a no-op.
,
PersistentObject.parseXml(Element)
protected void parseSubclassElements(org.w3c.dom.Element e) throws WavesetException
PersistentObject
parseSubclassElements
in class PersistentObject
WavesetException
PersistentObject's default implementation is a no-op.
,
PersistentObject.parseXml(Element)
public java.util.List listSummaryAttributes()
PersistentObject
defined attributes
that this type of persistent object exposes as summary attributes
(regardless of whether this particular object has a value for each).
Any subclass of PersistentObject that overrides this method
should first invoke super.listSummaryAttributes()
to ensure that the subclass includes summary attributes
that are common to all PersistentObjects.
Any subclass that overrides this implementation must also consider the length of the summary string that will be generated from these attributes.
listSummaryAttributes
in class PersistentObject
defined attributes
that this type of persistent object exposes as summary attributes
(regardless of whether this particular object has a value for each).
Any subclass of PersistentObject that overrides this method
should first invoke super.listSummaryAttributes()
to ensure that the subclass includes summary attributes
that are common to all PersistentObjects.
Constants.MAX_SUMMARY_STRING_LENGTH
,
PersistentObject.getSummaryString()
public WSAttributes getSummaryAttributes()
getSummaryAttributes
in class PersistentObject
attribute values
to be displayed when this object appears in a list.
The WSAttributes
contains
a WSAttribute
for each summary attribute.
Each WSAttribute
may contain multiple values.
Any subclass of PersistentObject that overrides this method
should first invoke super.getSummaryAttributes()
to ensure that the subclass includes summary attributes
that are common to all PersistentObjects.
If a subclass wants to expose a different set of summary attributes,
that subclass should override {@link #listSummaryAttributes}.
In order to supply values for summary attributes
that may not be available in PersistentObject
(e.g., from a field specified to that subclass),
such a subclass may also override {@link #getAttributeValues(Attribute)}.
A subclass should not need to override this method
(except to limit the number of values for a summary attribute).
protected WSAttribute getAttributeValues(java.lang.String attrName)
getAttributeValues
in class PersistentObject
attrName
- - the (name of the) attribute for which to return values.
WSAttribute
that represents the value (or values)
that this object contains for the specified attribute.
public static void resolveSummaryAttributes(ObjectCache cache, WSAttributes attrs) throws WavesetException
WavesetException
public java.util.List listQueryableAttributes()
listQueryableAttributes
in class PersistentObject
defined attributes
that this type of persistent object exposes as queryable attributes
(regardless of whether this particular object has a value for each).
Any subclass of PersistentObject that overrides this method
should first invoke super.listQueryableAttributes()
to ensure that the subclass includes queryable attributes
that are common to all PersistentObjects.
public java.util.List listQueryableReferenceAttributes()
listQueryableReferenceAttributes
in class PersistentObject
defined attributes
that this type of persistent object exposes as queryable
and for which each value is a reference
to another persistent object.public int compareTo(java.lang.Object o)
compareTo
in interface java.lang.Comparable
compareTo
in class PersistentObject
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |