wt.federation
Class ProxyGroup

java.lang.Object
  wt.fc.WTObject
      wt.fc.Item
          wt.org.WTPrincipal
              wt.org.WTGroup
                  wt.federation.ProxyGroup

All Implemented Interfaces:

AccessControlled, AccessControlList, AdHocControlled, BusinessInformation, DisplayIdentification, DomainAdministered, Externalizable, Federatable, Federated, NetFactor, ObjectMappable, Persistable, Principal, RecentlyVisited, RemoteAccess, RemotelyLinkable, Serializable

public class ProxyGroup

extends WTGroup

implements RemoteAccess, Federated, Externalizable

Proxy group of users.

Use the newProxyGroup static factory method(s), not the ProxyGroup 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: true

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
private long	expirationTime
static long	EXTERNALIZATION_VERSION_UID
private static String	FC_RESOURCE
private Vector	groups
private static Class	GroupUserLinkClass
protected static long	OLD_FORMAT_VERSION_UID
private long	refreshTime
private static String	RESOURCE
(package private) static long	serialVersionUID
(package private) static boolean	SERVER
private FederatedService	service
private ServiceIdentifier	serviceId
private String	sourceObjectId
private String	sourceURL

Fields inherited from class wt.org.WTGroup

DESCRIPTION, VERSION_50_UID

Fields inherited from class wt.org.WTPrincipal

ALL, DISABLED, DN, INFLATED, NAME, OWNER, REPAIR_NEEDED, REPOSITORY

Fields inherited from class wt.fc.Item

VERSION_40_UID, VERSION_51_UID

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.method.RemoteAccess

versionID

Fields inherited from interface wt.federation.Federated

EXPIRATION_TIME, REFRESH_TIME, SERVICE_ID, SOURCE_OBJECT_ID, SOURCE_URL

Fields inherited from interface wt.access.AdHocControlled

ENTRY_SET

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.fc.BusinessInformation

BUSINESS_TYPE, IDENTITY

Fields inherited from interface wt.ufid.Federatable

FEDERATABLE_INFO

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

ProxyGroup()
No-argument constructor returning an initialized instance of the class.

Method Summary

protected boolean	_isMember(WTPrincipal principal) Supported API: true
protected Enumeration	_members() Supported API: true
boolean	addMember(WTPrincipal principal) Adds a member to the group.
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
QueryResult	findLinks(Class targetLinkClass, String obj1Role, Persistable obj2) Return all link objects that exist between the Federated object and the specified source object.
Enumeration	getAllParentGroups()
String	getConceptualClassname() Deprecated.
long	getExpirationTime() Gets the value of the attribute: EXPIRATION_TIME.
long	getRefreshTime() Gets the value of the attribute: REFRESH_TIME.
FederatedService	getService() Return the service object referenced by the serviceId attribute.
ServiceIdentifier	getServiceId() Gets the object for the association that plays role: SERVICE_ID.
String	getSourceObjectId() Gets the value of the attribute: SOURCE_OBJECT_ID.
String	getSourceURL() Gets the value of the attribute: SOURCE_URL.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(String name) Supports initialization, following construction of an instance.
protected void	initialize(String name, ServiceIdentifier serviceId, String sourceObjectId) Supports initialization, following construction of an instance.
boolean	isMember(WTPrincipal principal) Supported API: true
Enumeration	members() Supported API: true
QueryResult	navigate(String role, Class linkClass, boolean onlyOtherSide) Return objects related to this federated source object given a role and link class.
QueryResult	navigate(String role, QuerySpec criteria, boolean onlyOtherSide) Return objects related to this federated source object given a role and link selection crtieria.
static ProxyGroup	newProxyGroup(String name) Supported API: false
static ProxyGroup	newProxyGroup(String name, ServiceIdentifier serviceId, String sourceObjectId) Supported API: false
void	postStore() The persistence manager calls this method just after storing the proxy object in the database.
void	prepareForStore() The persistence manager calls this method just before storing the proxy object in the database.
void	preset() This method is called when a proxy object is first created by a service, just after the object is instantiated and its readExternal method has been called to populate its properties from attributes obtained from the remote information source.
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(ProxyGroup thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	refresh() Refresh the derived attributes of the object.
void	refreshIfStale() Refresh the derived attributes of the object, but only if the properties are stale.
boolean	removeMember(WTPrincipal principal) Removes a member from the group.
private void	serviceIdValidate(ServiceIdentifier a_ServiceId)
void	setDisabled(boolean disabled) Supported API: false
void	setExpirationTime(long a_ExpirationTime) Sets the value of the attribute: EXPIRATION_TIME.
private void	setGroups()
void	setRefreshTime(long a_RefreshTime) Sets the value of the attribute: REFRESH_TIME.
void	setServiceId(ServiceIdentifier a_ServiceId) Sets the object for the association that plays role: SERVICE_ID.
void	setSourceObjectId(String a_SourceObjectId) Sets the value of the attribute: SOURCE_OBJECT_ID.
void	setSourceURL(String a_SourceURL) Sets the value of the attribute: SOURCE_URL.
private void	sourceObjectIdValidate(String a_SourceObjectId)
private void	sourceURLValidate(String a_SourceURL)
void	update() Update the derived attributes of the object on the source service.
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.org.WTGroup

addMembers, copyAttributes, getAttributeMap, getBusinessType, getDescription, getDn, getEntrySet, getFieldValueMap, getRepository, initialize, initialize, mapAttributes, newWTGroup, newWTGroup, newWTGroup, parentGroups, readVersion, setDescription, setDn, setEntrySet, setRepository, toString

Methods inherited from class wt.org.WTPrincipal

_mangleName, _setDisabled, _unmangleName, getDn, getFederatableInfo, getIdentificationObject, getIdentity, getName, getOrganization, getRepository, inflate, initialize, isDefaultDomain, isDisabled, isInflated, isRepairNeeded, readVersion, setDn, setFederatableInfo, setInflated, setName, setRepairNeeded, setRepository

Methods inherited from class wt.fc.Item

getDomainRef, isInheritedDomain, readVersion, setDomainRef, setInheritedDomain

Methods inherited from class wt.fc.WTObject

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface wt.fc.NetFactor

getClassInfo

Methods inherited from interface wt.fc.Persistable

checkAttributes, getIdentity, getPersistInfo, getType, setPersistInfo

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

SERVER

static final boolean SERVER

FC_RESOURCE

private static final String FC_RESOURCE

See Also:

Constant Field Values

sourceObjectId

private String sourceObjectId

sourceURL

private String sourceURL

expirationTime

private long expirationTime

refreshTime

private long refreshTime

serviceId

private ServiceIdentifier serviceId

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

service

private FederatedService service

GroupUserLinkClass

private static final Class GroupUserLinkClass

groups

private Vector groups

Constructor Detail

ProxyGroup

public ProxyGroup()
           throws WTException

No-argument constructor returning an initialized instance of the class. This is needed in order to ensure that ProxyGroup objects are fully initialized when created dynamically by FederatedService objects.

Throws:

WTException

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 WTGroup

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 WTGroup

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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 WTGroup

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

Overrides:

getConceptualClassname in class WTGroup

Returns:

String

newProxyGroup

public static ProxyGroup newProxyGroup(String name)
                                throws WTException

Supported API: false

Parameters:

name -

Returns:

ProxyGroup

Throws:

WTException

initialize

protected void initialize(String name)
                   throws WTException

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

Supported API: false

Overrides:

initialize in class WTGroup

Parameters:

name -

Throws:

WTException

newProxyGroup

public static ProxyGroup newProxyGroup(String name,
                                       ServiceIdentifier serviceId,
                                       String sourceObjectId)
                                throws WTException

Supported API: false

Parameters:

name -

serviceId -

sourceObjectId -

Returns:

ProxyGroup

Throws:

WTException

initialize

protected void initialize(String name,
                          ServiceIdentifier serviceId,
                          String sourceObjectId)
                   throws WTException

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

Supported API: false

Parameters:

name -

serviceId -

sourceObjectId -

Throws:

WTException

isMember

public boolean isMember(WTPrincipal principal)
                 throws WTException

Supported API: true

Overrides:

isMember in class WTGroup

Parameters:

principal -

Returns:

boolean

Throws:

WTException

_isMember

protected boolean _isMember(WTPrincipal principal)
                     throws WTException

Supported API: true

Parameters:

principal -

Returns:

boolean

Throws:

WTException

members

public Enumeration members()
                    throws WTException

Supported API: true

Overrides:

members in class WTGroup

Returns:

Enumeration

Throws:

WTException

_members

protected Enumeration _members()
                        throws WTException

Supported API: true

Returns:

Enumeration

Throws:

WTException

setDisabled

public void setDisabled(boolean disabled)
                 throws WTException,
                        WTPropertyVetoException

Supported API: false

Overrides:

setDisabled in class WTGroup

Parameters:

disabled -

Throws:

WTException

WTPropertyVetoException

getSourceObjectId

public String getSourceObjectId()

Gets the value of the attribute: SOURCE_OBJECT_ID.

Supported API: false

Specified by:

getSourceObjectId in interface Federated

Returns:

String

setSourceObjectId

public void setSourceObjectId(String a_SourceObjectId)
                       throws WTPropertyVetoException

Sets the value of the attribute: SOURCE_OBJECT_ID.

Supported API: false

Specified by:

setSourceObjectId in interface Federated

Parameters:

a_SourceObjectId -

Throws:

WTPropertyVetoException

sourceObjectIdValidate

private void sourceObjectIdValidate(String a_SourceObjectId)
                             throws WTPropertyVetoException

Parameters:

a_SourceObjectId -

Throws:

WTPropertyVetoException

getSourceURL

public String getSourceURL()

Gets the value of the attribute: SOURCE_URL.

Supported API: false

Specified by:

getSourceURL in interface Federated

Returns:

String

setSourceURL

public void setSourceURL(String a_SourceURL)
                  throws WTPropertyVetoException

Sets the value of the attribute: SOURCE_URL.

Supported API: false

Specified by:

setSourceURL in interface Federated

Parameters:

a_SourceURL -

Throws:

WTPropertyVetoException

sourceURLValidate

private void sourceURLValidate(String a_SourceURL)
                        throws WTPropertyVetoException

Parameters:

a_SourceURL -

Throws:

WTPropertyVetoException

getExpirationTime

public long getExpirationTime()

Gets the value of the attribute: EXPIRATION_TIME.

Supported API: false

Specified by:

getExpirationTime in interface Federated

Returns:

long

setExpirationTime

public void setExpirationTime(long a_ExpirationTime)
                       throws WTPropertyVetoException

Sets the value of the attribute: EXPIRATION_TIME.

Supported API: false

Specified by:

setExpirationTime in interface Federated

Parameters:

a_ExpirationTime -

Throws:

WTPropertyVetoException

getRefreshTime

public long getRefreshTime()

Gets the value of the attribute: REFRESH_TIME.

Supported API: false

Specified by:

getRefreshTime in interface Federated

Returns:

long

setRefreshTime

public void setRefreshTime(long a_RefreshTime)
                    throws WTPropertyVetoException

Sets the value of the attribute: REFRESH_TIME.

Supported API: false

Specified by:

setRefreshTime in interface Federated

Parameters:

a_RefreshTime -

Throws:

WTPropertyVetoException

getService

public FederatedService getService()
                            throws FederationServicesException

Return the service object referenced by the serviceId attribute.

Supported API: true

Specified by:

getService in interface Federated

Returns:

FederatedService

Throws:

FederationServicesException

preset

public void preset()
            throws FederationServicesException

This method is called when a proxy object is first created by a service, just after the object is instantiated and its readExternal method has been called to populate its properties from attributes obtained from the remote information source. This method allows the proxy object to do further class-specific initialization.

Supported API: true

Specified by:

preset in interface Federated

Throws:

FederationServicesException

refresh

public void refresh()
             throws FederationServicesException

Refresh the derived attributes of the object.

Supported API: true

Specified by:

refresh in interface Federated

Throws:

FederationServicesException

refreshIfStale

public void refreshIfStale()
                    throws FederationServicesException

Refresh the derived attributes of the object, but only if the properties are stale.

Supported API: true

Specified by:

refreshIfStale in interface Federated

Throws:

FederationServicesException

update

public void update()
            throws FederationServicesException

Update the derived attributes of the object on the source service.

Supported API: true

Specified by:

update in interface Federated

Throws:

FederationServicesException

prepareForStore

public void prepareForStore()
                     throws FederationServicesException

The persistence manager calls this method just before storing the proxy object in the database. This gives the object an opportunity to make associated proxy objects persistent, if necessary.

Supported API: true

Specified by:

prepareForStore in interface Federated

Throws:

FederationServicesException

findLinks

public QueryResult findLinks(Class targetLinkClass,
                             String obj1Role,
                             Persistable obj2)
                      throws FederationServicesException

Return all link objects that exist between the Federated object and the specified source object.

Supported API: true

Specified by:

findLinks in interface Federated

Parameters:

targetLinkClass -

obj1Role -

obj2 -

Returns:

QueryResult

Throws:

FederationServicesException

navigate

public QueryResult navigate(String role,
                            Class linkClass,
                            boolean onlyOtherSide)
                     throws FederationServicesException

Return objects related to this federated source object given a role and link class. Return only the related objects themselves if specified. Otherwise, return both the related objects as well as the link objects that associate them with the source object.

Supported API: true

Specified by:

navigate in interface Federated

Parameters:

role -

linkClass -

onlyOtherSide -

Returns:

QueryResult

Throws:

FederationServicesException

navigate

public QueryResult navigate(String role,
                            QuerySpec criteria,
                            boolean onlyOtherSide)
                     throws FederationServicesException

Return objects related to this federated source object given a role and link selection crtieria. Return only the related objects themselves if specified. Otherwise, return both the related objects as well as the link objects that associate them with the source object.

Supported API: true

Specified by:

navigate in interface Federated

Parameters:

role -

criteria -

onlyOtherSide -

Returns:

QueryResult

Throws:

FederationServicesException

postStore

public void postStore()
               throws FederationServicesException

The persistence manager calls this method just after storing the proxy object in the database. This gives the object an opportunity to make associated objects persistent, if necessary. For example, links between the proxy object and other objects need to be persisted after the proxy object is persisted.

Supported API: true

Specified by:

postStore in interface Federated

Throws:

FederationServicesException

getServiceId

public ServiceIdentifier getServiceId()

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

Supported API: true

Specified by:

getServiceId in interface Federated

Returns:

ServiceIdentifier

setServiceId

public void setServiceId(ServiceIdentifier a_ServiceId)
                  throws WTPropertyVetoException

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

Supported API: true

Specified by:

setServiceId in interface Federated

Parameters:

a_ServiceId -

Throws:

WTPropertyVetoException

serviceIdValidate

private void serviceIdValidate(ServiceIdentifier a_ServiceId)
                        throws WTPropertyVetoException

Parameters:

a_ServiceId -

Throws:

WTPropertyVetoException

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

Specified by:

equals in interface Principal

Overrides:

equals in class WTGroup

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

Specified by:

hashCode in interface Principal

Overrides:

hashCode in class WTGroup

Returns:

int

addMember

public boolean addMember(WTPrincipal principal)
                  throws WTException

Adds a member to the group. Returns true if user is added; false if user already belongs to group.

Supported API: true

Overrides:

addMember in class WTGroup

Parameters:

principal -

Returns:

boolean

Throws:

WTException

removeMember

public boolean removeMember(WTPrincipal principal)
                     throws WTException

Removes a member from the group. Returns true if user is removed; false if user doesn't belong to group.

Supported API: true

Overrides:

removeMember in class WTGroup

Parameters:

principal -

Returns:

boolean

Throws:

WTException

getAllParentGroups

public Enumeration getAllParentGroups()
                               throws WTException

Throws:

WTException

setGroups

private void setGroups()
                throws WTException

Throws:

WTException