org.unitedinternet.cosmo.security

Interface CosmoSecurityManager

public interface CosmoSecurityManager

Represents a server-wide security controller for Cosmo. It provides entry points for obtaining information about the authentication state of the currently executing thread or for initiating authentication (or overwriting the current state).

See Also:

CosmoSecurityContext

Method Summary

Modifier and Type	Method and Description
void	checkPermission(Item item, int permission) Validates that the current security context has the requested permission for the given item.
CosmoSecurityContext	getSecurityContext() Provides a CosmoSecurityContext representing a previously authenticated principal.
CosmoSecurityContext	initiateSecurityContext(String username, String password) Authenticates the given Cosmo credentials and registers a CosmoSecurityContext for them.
CosmoSecurityContext	initiateSecurityContext(User user) Initiate the current security context with the current user.
void	registerTickets(Set<Ticket> tickets) Associate additional tickets with the current security context.
void	unregisterTickets()

Method Detail

getSecurityContext

CosmoSecurityContext getSecurityContext()
                                 throws CosmoSecurityException

Provides a CosmoSecurityContext representing a previously authenticated principal.

Throws:

CosmoSecurityException

initiateSecurityContext

CosmoSecurityContext initiateSecurityContext(String username,
                                             String password)
                                      throws CosmoSecurityException

Authenticates the given Cosmo credentials and registers a CosmoSecurityContext for them. This method is used when Cosmo components need to programatically log in a user rather than relying on a security context already being in place.

Throws:

CosmoSecurityException

initiateSecurityContext

CosmoSecurityContext initiateSecurityContext(User user)
                                      throws CosmoSecurityException

Initiate the current security context with the current user. This method is used when the server needs to run code as a specific user.

Throws:

CosmoSecurityException

checkPermission

void checkPermission(Item item,
                     int permission)
              throws PermissionDeniedException

Validates that the current security context has the requested permission for the given item.

Throws:

PermissionDeniedException - if the security context does not have the required permission

registerTickets

void registerTickets(Set<Ticket> tickets)

Associate additional tickets with the current security context. Additional tickets allow a principal to have additional access to resources.

Parameters:

tickets - additional tickets to associate with the current security context

unregisterTickets

void unregisterTickets()