wt.access
Class PolicyAcl

java.lang.Object
  wt.fc.WTObject
      wt.access.PolicyAcl

All Implemented Interfaces:

DisplayIdentification, Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class PolicyAcl

extends WTObject

implements Externalizable

The PolicyAcl class represents access control lists (ACLs) that are associated with an access policy. An ACL for a given object is derived from the policy rules by combining all rules that apply to the object. For example, a rule in which the persistent type identifier "Document" occurs in its antecedent applies to all objects that are of type "Document" and its derived types. ACLs contain a selector that specifies the domain, type and state the ACL should be used for, and a set of entries. The selector is represented by the AccessSelector class and the set of entries by the AclEntrySet class.

Use the newPolicyAcl static factory method(s), not the PolicyAcl constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
protected static String	ENTRY_SET Label for the attribute; Set of access control entries for the list.
private AclEntrySet	entrySet
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
private AccessSelector	selector
static String	SELECTOR Label for the attribute.
(package private) static long	serialVersionUID

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

PolicyAcl()

Method Summary

boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
String	getConceptualClassname() Deprecated.
protected AclEntrySet	getEntrySet() Gets the value of the attribute: ENTRY_SET.
AccessSelector	getSelector() Gets the object for the association that plays role: SELECTOR.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(AccessSelector selector) Supports initialization, following construction of an instance.
static PolicyAcl	newPolicyAcl(AccessSelector selector) Constructs a policy ACL for a given selector.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(PolicyAcl thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
private void	selectorValidate(AccessSelector a_Selector)
protected void	setEntrySet(AclEntrySet a_EntrySet) Sets the value of the attribute: ENTRY_SET.
void	setSelector(AccessSelector a_Selector) Sets the object for the association that plays role: SELECTOR.
String	toString() Returns a String representation of the ACL.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class wt.fc.WTObject

checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, getModifyTimestamp, getPersistInfo, getType, initialize, readVersion, setPersistInfo

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

ENTRY_SET

protected static final String ENTRY_SET

Label for the attribute; Set of access control entries for the list.

Supported API: false

See Also:

Constant Field Values

entrySet

private AclEntrySet entrySet

SELECTOR

public static final String SELECTOR

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

selector

private AccessSelector selector

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

PolicyAcl

public PolicyAcl()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class WTObject

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class WTObject

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(PolicyAcl thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Overrides:

writeExternal in class WTObject

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Overrides:

readExternal in class WTObject

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

getEntrySet

protected AclEntrySet getEntrySet()

Gets the value of the attribute: ENTRY_SET. Set of access control entries for the list.

Supported API: false

Returns:

AclEntrySet

setEntrySet

protected void setEntrySet(AclEntrySet a_EntrySet)

Sets the value of the attribute: ENTRY_SET. Set of access control entries for the list.

Supported API: false

Parameters:

a_EntrySet -

getSelector

public AccessSelector getSelector()

Gets the object for the association that plays role: SELECTOR.

Supported API: false

Returns:

AccessSelector

setSelector

public void setSelector(AccessSelector a_Selector)
                 throws WTPropertyVetoException

Sets the object for the association that plays role: SELECTOR.

Supported API: false

Parameters:

a_Selector -

Throws:

WTPropertyVetoException

selectorValidate

private void selectorValidate(AccessSelector a_Selector)
                       throws WTPropertyVetoException

Parameters:

a_Selector -

Throws:

WTPropertyVetoException

newPolicyAcl

public static PolicyAcl newPolicyAcl(AccessSelector selector)
                              throws WTException

Constructs a policy ACL for a given selector.

Supported API: false

Parameters:

selector -

Returns:

PolicyAcl

Throws:

WTException

initialize

protected void initialize(AccessSelector selector)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Parameters:

selector -

Throws:

WTException

toString

public String toString()

Returns a String representation of the ACL.

Supported API: false

Overrides:

toString in class WTObject

Returns:

String

equals

public boolean equals(Object obj)

Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. Changed or stale copies are still considered equal by this method. Delegates to PersistenceHelper.equals(Persistable,Object).

Warning: Certain core Windchill operations may depend upon equals being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

equals in class WTObject

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this object based upon its ObjectIdentifier. Delegates to PersistenceHelper.hashCode(Persistable).

Warning: Certain core Windchill operations may depend upon hashCode being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

hashCode in class WTObject

Returns:

int