Package i5.las2peer.security

Class AgentContext

java.lang.Object

i5.las2peer.security.AgentContext

All Implemented Interfaces:

AgentStorage

public class AgentContext
extends Object
implements AgentStorage

A context that can be created for an agent to perform operations in the network. Cached in the node for remembering unlocked agents. Used for messaging and service calls.

Constructor Summary

Constructors

Constructor	Description
AgentContext(Node localNode, AgentImpl mainAgent)	Creates a new (local) context.

Method Summary

Modifier and Type	Method	Description
AgentImpl	getAgent(String id)	Uses this context as AgentStorage.
static AgentContext	getCurrent()	Gets the current las2peer context.
long	getLastUsageTimestamp()	Returns the time of the last usage of this context.
Node	getLocalNode()	Gives access to the local node.
AgentImpl	getMainAgent()	Gets the main agent of this context.
boolean	hasAccess(String agentId)	Checks if the agent can be accessed (e.g.
boolean	hasAgent(String id)	does this storage know the requested agent? Does not refer to the backup storage if applicable
boolean	isMemberRecursive(GroupAgentImpl groupAgent, String agentId)	Checks if the given agent is transitive member of the given group.
Agent	requestAgent(String agentId)	returns an unlocked instance of the requested Agent
GroupAgentImpl	requestGroupAgent(String groupId)	Tries to open the given id for this context.
void	touch()	Mark the current time as the last usage.
void	unlockMainAgent(String passphrase)	unlocks the main agent of this context

Methods inherited from class java.lang.Object

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

Constructor Details

AgentContext

public AgentContext(Node localNode,
 AgentImpl mainAgent)

Creates a new (local) context.

Parameters:

mainAgent - The main agent for this context.

localNode - The node this context is bound to.

Method Details

unlockMainAgent

public void unlockMainAgent(String passphrase)
                     throws AgentAccessDeniedException,
AgentOperationFailedException

unlocks the main agent of this context

Parameters:

passphrase - Passphrase of the agent

Throws:

AgentAccessDeniedException - If the passphrase is invalid.

AgentOperationFailedException - If the agent's private key can not be deserialized.

getMainAgent

public AgentImpl getMainAgent()

Gets the main agent of this context.

Returns:

the agent of this context

requestGroupAgent

public GroupAgentImpl requestGroupAgent(String groupId)
                                 throws AgentAccessDeniedException,
AgentNotFoundException,
AgentOperationFailedException

Tries to open the given id for this context.

Parameters:

groupId - The group id to fetch and unlock

Returns:

the unlocked GroupAgent of the given id

Throws:

AgentAccessDeniedException - If the group agent can not be unlocked

AgentNotFoundException - If the group agent could not be found or is not a group agent

AgentOperationFailedException - If the agent's keys can not be deserialized

requestAgent

public Agent requestAgent(String agentId)
                   throws AgentAccessDeniedException,
AgentNotFoundException,
AgentOperationFailedException

returns an unlocked instance of the requested Agent

Parameters:

agentId - the requested agent

Returns:

an unlocked agent instance

Throws:

AgentOperationFailedException

AgentNotFoundException

AgentAccessDeniedException

hasAccess

public boolean hasAccess(String agentId)
                  throws AgentNotFoundException

Checks if the agent can be accessed (e.g. unlocked) from this context.

Parameters:

agentId - The agent to be accessed

Returns:

true if the given agent can be unlocked.

Throws:

AgentNotFoundException - If the agent does not exist

isMemberRecursive

public boolean isMemberRecursive(GroupAgentImpl groupAgent,
 String agentId)

Checks if the given agent is transitive member of the given group.

Parameters:

groupAgent - The group

agentId - the agent to check if its member of the group

Returns:

true if it is a transitive member of the group.

getLocalNode

public Node getLocalNode()

Gives access to the local node.

Returns:

the local P2P node

touch

public void touch()

Mark the current time as the last usage.

getLastUsageTimestamp

public long getLastUsageTimestamp()

Returns the time of the last usage of this context.

Returns:

the timestamp of the last usage

getAgent

public AgentImpl getAgent(String id)
                   throws AgentException

Uses this context as AgentStorage. Returns agents that are unlocked in this context first. E.g. necessary for opening a received Message.

Specified by:

getAgent in interface AgentStorage

Parameters:

id -

Returns:

get the agent of the given id

Throws:

AgentException

AgentNotFoundException - If the agent is not found in this storage

hasAgent

public boolean hasAgent(String id)

Description copied from interface: AgentStorage

does this storage know the requested agent? Does not refer to the backup storage if applicable

Specified by:

hasAgent in interface AgentStorage

Returns:

true, if this storage knows an agent of the given id

getCurrent

public static AgentContext getCurrent()

Gets the current las2peer context.

Returns:

the current context

Throws:

IllegalStateException - called not in a las2peer execution thread