Package org.cristalise.kernel.lookup

Class AgentPath

java.lang.Object

org.cristalise.kernel.lookup.Path

org.cristalise.kernel.lookup.ItemPath

org.cristalise.kernel.lookup.AgentPath

All Implemented Interfaces:

C2KLocalObject

@Immutable
public class AgentPath
extends ItemPath

Extends ItemPath with Agent specific codes

Field Summary

Fields inherited from class org.cristalise.kernel.lookup.Path

delim, mPath

Constructor Summary

Constructors

Constructor	Description
AgentPath()
AgentPath(String path)
AgentPath(UUID uuid)
AgentPath(UUID uuid, String agentName)
AgentPath(UUID uuid, String agentName, boolean isPwdTemporary)
AgentPath(ItemPath itemPath)
AgentPath(ItemPath itemPath, String agentName)

Method Summary

Modifier and Type	Method	Description
String	dump()
String	getAgentName()
String	getAgentName(TransactionKey transactionKey)
String	getClusterPath()	Each C2KLocalObject is stored with a path identifier starting with the ClusterType: DomainPath: /Path/Domain/Name ItemPath: /Path/Item AgentPath: /Path/Agent RolePath: /Path/Role/Name Properties: /Property/Name Workflow: /LifeCycle/workflow Collections: /Collection/Name/Version (default Name='last') Outcomes: /Outcome/SchemaName/SchemaVersion/EventID Viewpoints: /ViewPoint/SchemaName/Name (default Name='last') Events: /AuditTrail/EventID Jobs: /Job/JobID
AgentProxy	getProxy()
AgentProxy	getProxy(TransactionKey transactionKey)
RolePath[]	getRoles()
RolePath[]	getRoles(TransactionKey transactionKey)
boolean	hasMatchingRole(List<RolePath> roles)
boolean	hasMatchingRole(List<RolePath> roles, TransactionKey transactionKey)
boolean	hasRole(String role)
boolean	hasRole(String role, TransactionKey transactionKey)
boolean	hasRole(RolePath role)
boolean	hasRole(RolePath role, TransactionKey transactionKey)
boolean	isPasswordTemporary()
void	setAgentName(String agentID)

Methods inherited from class org.cristalise.kernel.lookup.ItemPath

getItemName, getItemName, getItemPath, getName, getOID, getRoot, getUUID, isUUID, setPath, setPath, setPath, setSysKey

Methods inherited from class org.cristalise.kernel.lookup.Path

equals, exists, exists, getClusterType, getItemPath, getPath, getString, getStringPath, getStringPath, hashCode, setName, toString

Methods inherited from class java.lang.Object

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

Constructor Details

AgentPath

public AgentPath()

AgentPath

public AgentPath(UUID uuid,
 String agentName,
 boolean isPwdTemporary)

AgentPath

public AgentPath(UUID uuid)
          throws InvalidItemPathException

Throws:

InvalidItemPathException

AgentPath

public AgentPath(ItemPath itemPath)
          throws InvalidItemPathException

Throws:

InvalidItemPathException

AgentPath

public AgentPath(String path)
          throws InvalidItemPathException

Throws:

InvalidItemPathException

AgentPath

public AgentPath(ItemPath itemPath,
 String agentName)

AgentPath

public AgentPath(UUID uuid,
 String agentName)

Method Details

setAgentName

public void setAgentName(String agentID)

getAgentName

public String getAgentName()

getAgentName

public String getAgentName(TransactionKey transactionKey)

getRoles

public RolePath[] getRoles()

getRoles

public RolePath[] getRoles(TransactionKey transactionKey)

hasMatchingRole

public boolean hasMatchingRole(List<RolePath> roles)

hasMatchingRole

public boolean hasMatchingRole(List<RolePath> roles,
 TransactionKey transactionKey)

hasRole

public boolean hasRole(RolePath role)

hasRole

public boolean hasRole(RolePath role,
 TransactionKey transactionKey)

hasRole

public boolean hasRole(String role)

hasRole

public boolean hasRole(String role,
 TransactionKey transactionKey)

getClusterPath

public String getClusterPath()

Description copied from interface: C2KLocalObject

Each C2KLocalObject is stored with a path identifier starting with the ClusterType:

• DomainPath: /Path/Domain/Name
• ItemPath: /Path/Item
• AgentPath: /Path/Agent
• RolePath: /Path/Role/Name
• Properties: /Property/Name
• Workflow: /LifeCycle/workflow
• Collections: /Collection/Name/Version (default Name='last')
• Outcomes: /Outcome/SchemaName/SchemaVersion/EventID
• Viewpoints: /ViewPoint/SchemaName/Name (default Name='last')
• Events: /AuditTrail/EventID
• Jobs: /Job/JobID

Specified by:

getClusterPath in interface C2KLocalObject

Overrides:

getClusterPath in class ItemPath

Returns:

The path identifier (i.e. primary key) of the object

getProxy

public AgentProxy getProxy()
                    throws ObjectNotFoundException

Overrides:

getProxy in class ItemPath

Throws:

ObjectNotFoundException

getProxy

public AgentProxy getProxy(TransactionKey transactionKey)
                    throws ObjectNotFoundException

Overrides:

getProxy in class ItemPath

Throws:

ObjectNotFoundException

dump

public String dump()

Overrides:

dump in class Path

isPasswordTemporary

public boolean isPasswordTemporary()