Package i5.las2peer.security

Class UserAgentManager

java.lang.Object

i5.las2peer.security.UserAgentManager

public class UserAgentManager
extends Object

Maps usernames and emails to UserAgentImpls.

Constructor Summary

Constructors

Constructor	Description
UserAgentManager(Node node)

Method Summary

Modifier and Type	Method	Description
String	getAgentId(String prefixedIdentifier)	Get agent ID for a prefixed identifier, i.e., a string consisting of one of the prefixes defined in this class and the corresponding attribute (e.g., email address).
String	getAgentIdByEmail(String email)	get an UserAgentImpl's id by email address
String	getAgentIdByGroupName(String groupName)	get an GroupAgentImpl's id by group name
String	getAgentIdByLogin(String name)	get an UserAgentImpl's id by login name
String	getAgentIdByOIDCSub(String sub)	Gets an UserAgentImpl's id by OIDC sub.
void	registerGroupAgent(GroupAgent agent)	Stores group name of a group agent to the network
void	registerOIDCSub(UserAgentImpl agent, String sub)	Stores OIDC sub of an user agent to the network
void	registerUserAgent(UserAgent agent)	Stores login name and email of an user agent to the network

Methods inherited from class java.lang.Object

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

Constructor Details

UserAgentManager

public UserAgentManager(Node node)

Method Details

registerUserAgent

public void registerUserAgent(UserAgent agent)
                       throws EmailAlreadyTakenException,
LoginNameAlreadyTakenException,
AgentLockedException

Stores login name and email of an user agent to the network

Parameters:

agent - an unlocked UserAgent

Throws:

EmailAlreadyTakenException - If the given email is already in use by another agent

LoginNameAlreadyTakenException - If the given login name is already in use by another agent

AgentLockedException - If the given agent is not unlocked

registerGroupAgent

public void registerGroupAgent(GroupAgent agent)
                        throws LoginNameAlreadyTakenException,
NameAlreadyBoundException,
AgentLockedException

Stores group name of a group agent to the network

Parameters:

agent - an unlocked GroupAgent

Throws:

AgentLockedException - If the given agent is not unlocked

LoginNameAlreadyTakenException

NameAlreadyBoundException

registerOIDCSub

public void registerOIDCSub(UserAgentImpl agent,
 String sub)
                     throws OIDCSubAlreadyTakenException,
AgentLockedException

Stores OIDC sub of an user agent to the network

Parameters:

agent - an unlocked UserAgent

sub - The OIDC sub to register for this agent

Throws:

OIDCSubAlreadyTakenException - If the given OIDC sub is already registered

AgentLockedException - If the given agent is not unlocked

getAgentId

public String getAgentId(String prefixedIdentifier)
                  throws AgentNotFoundException,
AgentOperationFailedException

Get agent ID for a prefixed identifier, i.e., a string consisting of one of the prefixes defined in this class and the corresponding attribute (e.g., email address).

Parameters:

prefixedIdentifier -

Returns:

agent ID

Throws:

AgentNotFoundException

AgentOperationFailedException

getAgentIdByLogin

public String getAgentIdByLogin(String name)
                         throws AgentNotFoundException,
AgentOperationFailedException

get an UserAgentImpl's id by login name

Parameters:

name -

Returns:

the id of the agent

Throws:

AgentNotFoundException - If no agent for the given login is found

AgentOperationFailedException - If any other issue with the agent occurs, e. g. XML not readable

getAgentIdByEmail

public String getAgentIdByEmail(String email)
                         throws AgentNotFoundException,
AgentOperationFailedException

get an UserAgentImpl's id by email address

Parameters:

email -

Returns:

the id of the agent

Throws:

AgentNotFoundException - If no agent for the given email is found

AgentOperationFailedException - If any other issue with the agent occurs, e. g. XML not readable

getAgentIdByOIDCSub

public String getAgentIdByOIDCSub(String sub)
                           throws AgentNotFoundException,
AgentOperationFailedException

Gets an UserAgentImpl's id by OIDC sub.

Parameters:

sub - The OIDC sub to identify the user.

Returns:

The id of the agent

Throws:

AgentNotFoundException - If no agent for the given sub is found

AgentOperationFailedException - If any other issue with the agent occurs, e. g. XML not readable

getAgentIdByGroupName

public String getAgentIdByGroupName(String groupName)
                             throws AgentNotFoundException,
AgentOperationFailedException

get an GroupAgentImpl's id by group name

Parameters:

groupName -

Returns:

the id of the agent

Throws:

AgentNotFoundException - If no agent for the given login is found

AgentOperationFailedException - If any other issue with the agent occurs, e. g. XML not readable