wt.access
Class AdHocAclSpec

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

All Implemented Interfaces:

DisplayIdentification, Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class AdHocAclSpec

extends WTObject

implements Externalizable

This class represents a specification for constructing ad hoc access control rules. AdHocAclSpec objects are first class objects that can be used in many different lifecycle phases.

Use the newAdHocAclSpec static factory method(s), not the AdHocAclSpec 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
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
protected static long	PRE_R6_VERSION_UID
protected static long	R6_VERSION_UID
private static String	RESOURCE
private Hashtable	rolePermissions
(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

AdHocAclSpec()

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 long	getRolePermissionMask(Role role)
EnumeratorVector	getRolePermissions(Role role) Returns the set of permissions defined for the specified role in the specification.
Enumeration	getRoles() Returns the roles for which permissions are defined in the specification.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize() Initializes objects created by new-factory methods.
static AdHocAclSpec	newAdHocAclSpec() Supported API: false
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 void	readOldEntrySet(AclEntrySet entrySet)
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(AdHocAclSpec thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	removeRolePermissions(Role role) Removes the set of permissions defined for a role from the specification.
void	setRolePermissions(Role role, Vector permissions) Sets the permissions defined for a role in the specification.
String	toString() Supported API: false
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, 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

rolePermissions

private Hashtable rolePermissions

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

PRE_R6_VERSION_UID

protected static final long PRE_R6_VERSION_UID

See Also:

Constant Field Values

R6_VERSION_UID

protected static final long R6_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

AdHocAclSpec

public AdHocAclSpec()

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(AdHocAclSpec 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

newAdHocAclSpec

public static AdHocAclSpec newAdHocAclSpec()
                                    throws WTException

Supported API: false

Returns:

AdHocAclSpec

Throws:

WTException

toString

public String toString()

Supported API: false

Overrides:

toString in class WTObject

Returns:

String

getRolePermissions

public EnumeratorVector getRolePermissions(Role role)

Returns the set of permissions defined for the specified role in the specification. The result is an Enumeration of wt.access.AccessPermission.

Supported API: false

Parameters:

role - role

Returns:

EnumeratorVector

getRoles

public Enumeration getRoles()

Returns the roles for which permissions are defined in the specification. The result is an Enumeration of wt.project.Role.

Supported API: false

Returns:

Enumeration

removeRolePermissions

public void removeRolePermissions(Role role)

Removes the set of permissions defined for a role from the specification.

Supported API: false

Parameters:

role - role for which permissions are to be removed

setRolePermissions

public void setRolePermissions(Role role,
                               Vector permissions)

Sets the permissions defined for a role in the specification. If permissions are already defined for the role, the existing set of permissions are replaced. Otherwise the permissions are added.

Supported API: false

Parameters:

role - role to be granted the specified permissions

permissions - Vector of wt.access.AccessPermission

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

getRolePermissionMask

protected long getRolePermissionMask(Role role)

initialize

protected void initialize()
                   throws WTException

Description copied from class: WTObject

Initializes objects created by new-factory methods.

Supported API: false

Overrides:

initialize in class WTObject

Throws:

WTException

readOldEntrySet

private void readOldEntrySet(AclEntrySet entrySet)