Package pl.edu.icm.unity.engine.api

Interface RealmsManagement

public interface RealmsManagement

Authentication realm is a group of endpoints which share the same authentication context: in the first place login session. Also other artifacts can have realm scope, for instance the transient identities.

Author:

K. Benedyczak

Method Summary

Modifier and Type	Method	Description
void	addRealm(AuthenticationRealm realm)	Creates a new realm
AuthenticationRealm	getRealm(String name)	Returns a realm by name
Collection<AuthenticationRealm>	getRealms()	Returns all defined realms
void	removeRealm(String name)	Remove realm
void	updateRealm(AuthenticationRealm realm)	Update realm

Method Detail

addRealm

void addRealm(AuthenticationRealm realm)
       throws EngineException

Creates a new realm

Parameters:

realm -

Throws:

EngineException

getRealm

AuthenticationRealm getRealm(String name)
                      throws WrongArgumentException,
                             EngineException

Returns a realm by name

Parameters:

name -

Returns:

Throws:

WrongArgumentException

EngineException

getRealms

Collection<AuthenticationRealm> getRealms()
                                   throws EngineException

Returns all defined realms

Returns:

Throws:

EngineException

updateRealm

void updateRealm(AuthenticationRealm realm)
          throws EngineException

Update realm

Parameters:

realm -

Throws:

EngineException

removeRealm

void removeRealm(String name)
          throws EngineException

Remove realm

Parameters:

name -

Throws:

EngineException