wt.access
Class WTAclEntry

java.lang.Object
  wt.access.WTAclEntry

All Implemented Interfaces:

Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class WTAclEntry

extends Object

implements Persistable, Externalizable

WTAclEntry represents a mapping between a principal (user, group or organization) and a set of permissions. Each entry can be positive (representing permissions granted) or negative (representing permissions denied).

Use the newWTAclEntry static factory method(s), not the WTAclEntry 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

static String	ACL Label for the attribute.
static String	ACL_REFERENCE Label for the attribute.
private ObjectReference	aclReference
private static String	CLASSNAME
private boolean	disabled
protected static String	DISABLED Label for the attribute; String that identifies the owner of the entry.
static long	EXTERNALIZATION_VERSION_UID
private boolean	negative
static String	NEGATIVE Label for the attribute; Indicates whether the entry grants or denys the associated principal the set of permissions in the entry.
protected static long	OLD_FORMAT_VERSION_UID
private String	owner
protected static String	OWNER Label for the attribute; String that identifies the owner of the entry.
private static int	OWNER_UPPER_LIMIT
protected static String	PERMISSION_MASK Label for the attribute; Set of permissions (actions) of the entry represented as a bit map.
private long	permissionMask
static String	PRINCIPAL_REFERENCE Label for the attribute; A reference to the principal for which the rights are granted or denied.
private WTPrincipalReference	principalReference
private static String	RESOURCE
(package private) static long	serialVersionUID
private PersistInfo	thePersistInfo

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Constructor Summary

WTAclEntry()

Method Summary

private void	aclReferenceValidate(ObjectReference a_AclReference)
void	checkAttributes() Validate the values of this Persistable object's attributes.
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
AccessControlList	getAcl() Gets the object for the association that plays role: ACL.
ObjectReference	getAclReference() Gets the value of the attribute: ACL_REFERENCE.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
String	getIdentity() Deprecated. Replaced by IdentityFactory.getDispayIdentifier(object) to return a localizable equivalent of getIdentity(). To return a localizable value which includes the object type, use IdentityFactory.getDisplayIdentity(object). Other alternatives are ((WTObject)obj).getDisplayIdentifier() and ((WTObject)obj).getDisplayIdentity().
protected String	getOwner() Gets the value of the attribute: OWNER.
long	getOwnerId() Gets the identifier used by the entry's owner to qualify the owner key.
AdHocAccessKey	getOwnerKey() Gets the key identifying the entry's owner.
protected long	getPermissionMask() Gets the value of the attribute: PERMISSION_MASK.
EnumeratorVector	getPermissions() Returns the permissions contained in the entry's permission set.
PersistInfo	getPersistInfo() Gets the object for the association that plays role: PERSIST_INFO.
WTPrincipalReference	getPrincipalReference() Gets the value of the attribute: PRINCIPAL_REFERENCE.
String	getType() Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getType(). Another alternative is ((WTObject)obj).getDisplayType().
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize() Supports initialization, following construction of an instance.
protected boolean	isDisabled() Gets the value of the attribute: DISABLED.
boolean	isNegative() Gets the value of the attribute: NEGATIVE.
static WTAclEntry	newWTAclEntry() No-arg constructor.
private void	ownerValidate(String a_Owner)
private void	principalReferenceValidate(WTPrincipalReference a_PrincipalReference)
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(WTAclEntry thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
protected void	setAcl(AccessControlList a_Acl) Sets the object for the association that plays role: ACL.
protected void	setAclReference(ObjectReference a_AclReference) Sets the value of the attribute: ACL_REFERENCE.
protected void	setDisabled(boolean a_Disabled) Sets the value of the attribute: DISABLED.
protected void	setNegative(boolean a_Negative) Sets the value of the attribute: NEGATIVE.
protected void	setOwner(String a_Owner) Sets the value of the attribute: OWNER.
protected void	setPermissionMask(long a_PermissionMask) Sets the value of the attribute: PERMISSION_MASK.
void	setPersistInfo(PersistInfo a_PersistInfo) Sets the object for the association that plays role: PERSIST_INFO.
protected void	setPrincipalReference(WTPrincipalReference a_PrincipalReference) Sets the value of the attribute: PRINCIPAL_REFERENCE.
String	toString() Returns the conceptual (modeled) name for the class.
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 java.lang.Object

clone, finalize, 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

OWNER

protected static final String OWNER

Label for the attribute; String that identifies the owner of the entry.

Supported API: false

See Also:

Constant Field Values

OWNER_UPPER_LIMIT

private static int OWNER_UPPER_LIMIT

owner

private String owner

DISABLED

protected static final String DISABLED

Label for the attribute; String that identifies the owner of the entry.

Supported API: false

See Also:

Constant Field Values

disabled

private boolean disabled

NEGATIVE

public static final String NEGATIVE

Label for the attribute; Indicates whether the entry grants or denys the associated principal the set of permissions in the entry. True if the entry is negative (denys permissions) and false if the entry is positive (grants permissions).

Supported API: false

See Also:

Constant Field Values

negative

private boolean negative

PRINCIPAL_REFERENCE

public static final String PRINCIPAL_REFERENCE

Label for the attribute; A reference to the principal for which the rights are granted or denied.

Supported API: false

See Also:

Constant Field Values

principalReference

private WTPrincipalReference principalReference

PERMISSION_MASK

protected static final String PERMISSION_MASK

Label for the attribute; Set of permissions (actions) of the entry represented as a bit map.

Supported API: false

See Also:

Constant Field Values

permissionMask

private long permissionMask

ACL

public static final String ACL

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

ACL_REFERENCE

public static final String ACL_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

aclReference

private ObjectReference aclReference

thePersistInfo

private PersistInfo thePersistInfo

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

WTAclEntry

public WTAclEntry()

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

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

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(WTAclEntry 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

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

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

toString

public String toString()

Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:

String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException

Returns the ClassInfo object for this class.

Supported API: false

Specified by:

getClassInfo in interface NetFactor

Returns:

ClassInfo

Throws:

WTIntrospectionException

getOwner

protected String getOwner()

Gets the value of the attribute: OWNER. String that identifies the owner of the entry.

Supported API: false

Returns:

String

setOwner

protected void setOwner(String a_Owner)
                 throws WTPropertyVetoException

Sets the value of the attribute: OWNER. String that identifies the owner of the entry.

Supported API: false

Parameters:

a_Owner -

Throws:

WTPropertyVetoException

ownerValidate

private void ownerValidate(String a_Owner)
                    throws WTPropertyVetoException

Parameters:

a_Owner -

Throws:

WTPropertyVetoException

isDisabled

protected boolean isDisabled()

Gets the value of the attribute: DISABLED. String that identifies the owner of the entry.

Supported API: false

Returns:

boolean

setDisabled

protected void setDisabled(boolean a_Disabled)

Sets the value of the attribute: DISABLED. String that identifies the owner of the entry.

Supported API: false

Parameters:

a_Disabled -

isNegative

public boolean isNegative()

Gets the value of the attribute: NEGATIVE. Indicates whether the entry grants or denys the associated principal the set of permissions in the entry. True if the entry is negative (denys permissions) and false if the entry is positive (grants permissions).

Supported API: false

Returns:

boolean

setNegative

protected void setNegative(boolean a_Negative)

Sets the value of the attribute: NEGATIVE. Indicates whether the entry grants or denys the associated principal the set of permissions in the entry. True if the entry is negative (denys permissions) and false if the entry is positive (grants permissions).

Supported API: false

Parameters:

a_Negative -

getPrincipalReference

public WTPrincipalReference getPrincipalReference()

Gets the value of the attribute: PRINCIPAL_REFERENCE. A reference to the principal for which the rights are granted or denied.

Supported API: false

Returns:

WTPrincipalReference

setPrincipalReference

protected void setPrincipalReference(WTPrincipalReference a_PrincipalReference)
                              throws WTPropertyVetoException

Sets the value of the attribute: PRINCIPAL_REFERENCE. A reference to the principal for which the rights are granted or denied.

Supported API: false

Parameters:

a_PrincipalReference -

Throws:

WTPropertyVetoException

principalReferenceValidate

private void principalReferenceValidate(WTPrincipalReference a_PrincipalReference)
                                 throws WTPropertyVetoException

Parameters:

a_PrincipalReference -

Throws:

WTPropertyVetoException

getPermissionMask

protected long getPermissionMask()

Gets the value of the attribute: PERMISSION_MASK. Set of permissions (actions) of the entry represented as a bit map.

Supported API: false

Returns:

long

setPermissionMask

protected void setPermissionMask(long a_PermissionMask)

Sets the value of the attribute: PERMISSION_MASK. Set of permissions (actions) of the entry represented as a bit map.

Supported API: false

Parameters:

a_PermissionMask -

getAcl

public AccessControlList getAcl()

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

Supported API: false

Returns:

AccessControlList

setAcl

protected void setAcl(AccessControlList a_Acl)
               throws WTPropertyVetoException,
                      WTException

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

Supported API: false

Parameters:

a_Acl -

Throws:

WTPropertyVetoException

WTException

getAclReference

public ObjectReference getAclReference()

Gets the value of the attribute: ACL_REFERENCE.

Supported API: false

Returns:

ObjectReference

setAclReference

protected void setAclReference(ObjectReference a_AclReference)
                        throws WTPropertyVetoException

Sets the value of the attribute: ACL_REFERENCE.

Supported API: false

Parameters:

a_AclReference -

Throws:

WTPropertyVetoException

aclReferenceValidate

private void aclReferenceValidate(ObjectReference a_AclReference)
                           throws WTPropertyVetoException

Parameters:

a_AclReference -

Throws:

WTPropertyVetoException

newWTAclEntry

public static WTAclEntry newWTAclEntry()
                                throws WTException

No-arg constructor. Produces an empty positive entry. This constructor is not to be used externally but only by externalization.

Supported API: false

Returns:

WTAclEntry

Throws:

WTException

initialize

protected void initialize()
                   throws WTException

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

Supported API: false

Throws:

WTException

getOwnerKey

public AdHocAccessKey getOwnerKey()

Gets the key identifying the entry's owner. The owner key is only used for ad hoc access entries.

Supported API: false

Returns:

AdHocAccessKey

getOwnerId

public long getOwnerId()

Gets the identifier used by the entry's owner to qualify the owner key. The owner id is only used for ad hoc access entries.

Supported API: false

Returns:

long

getPermissions

public EnumeratorVector getPermissions()

Returns the permissions contained in the entry's permission set.

Supported API: false

Returns:

EnumeratorVector

getIdentity

public String getIdentity()

Deprecated. Replaced by IdentityFactory.getDispayIdentifier(object) to return a localizable equivalent of getIdentity(). To return a localizable value which includes the object type, use IdentityFactory.getDisplayIdentity(object). Other alternatives are ((WTObject)obj).getDisplayIdentifier() and ((WTObject)obj).getDisplayIdentity().

Gets the value of the attribute: IDENTITY. Supplies the identity of the object for business purposes. The identity is composed of name, number or possibly other attributes. The identity does not include the type of the object.

Supported API: false

Specified by:

getIdentity in interface Persistable

Returns:

String

getType

public String getType()

Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getType(). Another alternative is ((WTObject)obj).getDisplayType().

Gets the value of the attribute: TYPE. Identifies the type of the object for business purposes. This is typically the class name of the object but may be derived from some other attribute of the object.

Supported API: false

Specified by:

getType in interface Persistable

Returns:

String

checkAttributes

public void checkAttributes()
                     throws InvalidAttributeException

Validate the values of this Persistable object's attributes.

Supported API: false

Specified by:

checkAttributes in interface Persistable

Throws:

InvalidAttributeException

getPersistInfo

public PersistInfo getPersistInfo()

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

Supported API: false

Specified by:

getPersistInfo in interface Persistable

Returns:

PersistInfo

setPersistInfo

public void setPersistInfo(PersistInfo a_PersistInfo)

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

Supported API: false

Specified by:

setPersistInfo in interface Persistable

Parameters:

a_PersistInfo -

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

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

Returns:

int