com.agapsys.security

Class RoleRepository

java.lang.Object

com.agapsys.security.NamedObjectRepository<Role>

com.agapsys.security.RoleRepository

public class RoleRepository
extends NamedObjectRepository<Role>

Represents a repository of roles for an application.

Method Summary

Modifier and Type	Method and Description
Role	createRole(String roleName) Creates a role and adds it this repository
Role	getOrCreate(String roleName) Gets a role from this repository or creates a new one if there is no such role
static RoleRepository	getSingletonInstance()

Methods inherited from class com.agapsys.security.NamedObjectRepository

add, clear, contains, get, remove

Methods inherited from class java.lang.Object

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

Method Detail

getSingletonInstance

public static RoleRepository getSingletonInstance()

Returns:

A singleton instance for this application.

createRole

public Role createRole(String roleName)
                throws IllegalArgumentException,
                       DuplicateException

Creates a role and adds it this repository

Parameters:

roleName - name of the role to be created. Must be unique in the repository

Returns:

created role

Throws:

DuplicateException - if a role with the same name was already created

IllegalArgumentException - if (roleName == null || roleName.isEmpty())

getOrCreate

public Role getOrCreate(String roleName)
                 throws IllegalArgumentException

Gets a role from this repository or creates a new one if there is no such role

Parameters:

roleName - role to be obtained/created

Returns:

role instance

Throws:

IllegalArgumentException - if (roleName == null || roleName.isEmpty())