Package org.cristalise.kernel.entity.imports

Class ImportAgent

java.lang.Object

org.cristalise.kernel.process.module.ModuleImport

org.cristalise.kernel.entity.imports.ImportAgent

All Implemented Interfaces:

DescriptionObject

public class ImportAgent
extends ModuleImport
implements DescriptionObject

Field Summary

Fields

Modifier and Type	Field	Description
protected Integer	version

Fields inherited from class org.cristalise.kernel.process.module.ModuleImport

domainPath, isDOMPathExists, isNewItem, itemPath, name, ns, resourceChangeDetails, resourceChangeStatus

Constructor Summary

Constructors

Constructor	Description
ImportAgent()
ImportAgent(String aName, String pwd)	Constructor with mandatory fields
ImportAgent(String folder, String aName, Integer version, String pwd)
ImportAgent(String folder, String aName, String pwd)

Method Summary

Modifier and Type	Method	Description
void	addRole(String roleName)
void	addRole(ImportRole ir)
void	addRole(RolePath rp)
void	addRole(BuiltInAuthc role)
void	addRoles(List<RolePath> newRoles)
Path	create(AgentPath agentPath, boolean reset, TransactionKey transactionKey)
boolean	exists(TransactionKey transactionKey)
AgentPath	getAgentPath()
AgentPath	getAgentPath(TransactionKey transactionKey)
DomainPath	getDomainPath()
String	getItemID()
ItemPath	getItemPath(TransactionKey transactionKey)	Sets the ItemPath representing the Agent.
AgentProxy	getProxy()
BuiltInResources	getResourceType()
CollectionArrayList	makeDescCollections(TransactionKey transactionKey)
void	setID(String uuid)
String	toString()

Methods inherited from class org.cristalise.kernel.process.module.ModuleImport

getID, getNamespace, hashCode, setNamespace

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cristalise.kernel.utils.DescriptionObject

export, getItemPath, getName, getNamespace, getVersion, getXml, getXml, makeDescCollection, setItemPath, setName, setNamespace, setVersion, toOutcome

Field Details

version

protected Integer version

Constructor Details

ImportAgent

public ImportAgent()

ImportAgent

public ImportAgent(String folder,
 String aName,
 Integer version,
 String pwd)

ImportAgent

public ImportAgent(String folder,
 String aName,
 String pwd)

ImportAgent

public ImportAgent(String aName,
 String pwd)

Constructor with mandatory fields

Parameters:

aName - name of the agent

pwd - the password of the agent

Method Details

setID

public void setID(String uuid)
           throws InvalidItemPathException

Overrides:

setID in class ModuleImport

Throws:

InvalidItemPathException

getDomainPath

public DomainPath getDomainPath()

exists

public boolean exists(TransactionKey transactionKey)

Specified by:

exists in interface DescriptionObject

create

public Path create(AgentPath agentPath,
 boolean reset,
 TransactionKey transactionKey)
            throws ObjectNotFoundException,
ObjectCannotBeUpdated,
CannotManageException,
ObjectAlreadyExistsException

Specified by:

create in class ModuleImport

Throws:

ObjectNotFoundException

ObjectCannotBeUpdated

CannotManageException

ObjectAlreadyExistsException

getAgentPath

public AgentPath getAgentPath()

getProxy

public AgentProxy getProxy()

getAgentPath

public AgentPath getAgentPath(TransactionKey transactionKey)

getItemPath

public ItemPath getItemPath(TransactionKey transactionKey)

Sets the ItemPath representing the Agent. Tries to find Agent if it already exists, otherwise creates new ItemPath, i.e. it creates new UUID.

Overrides:

getItemPath in class ModuleImport

addRoles

public void addRoles(List<RolePath> newRoles)

addRole

public void addRole(BuiltInAuthc role)

addRole

public void addRole(String roleName)

addRole

public void addRole(ImportRole ir)

addRole

public void addRole(RolePath rp)

getItemID

public String getItemID()

Specified by:

getItemID in interface DescriptionObject

makeDescCollections

public CollectionArrayList makeDescCollections(TransactionKey transactionKey)
                                        throws InvalidDataException,
ObjectNotFoundException

Specified by:

makeDescCollections in interface DescriptionObject

Throws:

InvalidDataException

ObjectNotFoundException

getResourceType

public BuiltInResources getResourceType()

Specified by:

getResourceType in interface DescriptionObject

toString

public String toString()

Overrides:

toString in class Object