001: /*
002: * CoadunationLib: The coaduntion implementation library.
003: * Copyright (C) 2006 Rift IT Contracting
004: *
005: * This library is free software; you can redistribute it and/or
006: * modify it under the terms of the GNU Lesser General Public
007: * License as published by the Free Software Foundation; either
008: * version 2.1 of the License, or (at your option) any later version.
009: *
010: * This library is distributed in the hope that it will be useful,
011: * but WITHOUT ANY WARRANTY; without even the implied warranty of
012: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
013: * Lesser General Public License for more details.
014: *
015: * You should have received a copy of the GNU Lesser General Public
016: * License along with this library; if not, write to the Free Software
017: * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
018: *
019: * ThreadsPermissionContainer.java
020: *
021: * This object contains all the thread permissions. It is not a singleton
022: * as a result only the object designed to have the rights to elevate or
023: * manipulate a threads premissions directly can access this object.
024: */
025:
026: // package definition
027: package com.rift.coad.lib.security;
028:
029: // the java imports
030: import java.util.Map;
031: import java.util.HashMap;
032:
033: // log 4 j imports
034: import org.apache.log4j.Logger;
035:
036: /**
037: * This object contains all the thread permissions. It is not a singleton
038: * as a result only the object designed to have the rights to elevate or
039: * manipulate a threads premissions directly can access this object.
040: *
041: * @author Brett Chaldecott
042: */
043: public class ThreadsPermissionContainer {
044:
045: // log object
046: private Logger log = Logger
047: .getLogger(ThreadsPermissionContainer.class.getName());
048:
049: // the map in which all the information is stored.
050: private Map permissions = null;
051:
052: /**
053: * Creates a new instance of ThreadsPermissionContainer
054: */
055: public ThreadsPermissionContainer() {
056: permissions = new HashMap();
057: }
058:
059: /**
060: * This method placeses the new thread session in the threads list.
061: *
062: * @param threadId The id of the new thread to plase in the map.
063: * @param session The session to add to the list.
064: */
065: public synchronized void putSession(Long threadId,
066: ThreadPermissionSession session) {
067: permissions.put(threadId, session);
068: }
069:
070: /**
071: * This method retrieves the session information from the map. Will return
072: * null if the session is not found.
073: *
074: * @return The list of permissions.
075: * @param threadId The id of the thread.
076: * @exception SecurityException
077: */
078: public synchronized ThreadPermissionSession getSession(Long threadId)
079: throws SecurityException {
080: return (ThreadPermissionSession) permissions.get(threadId);
081: }
082:
083: /**
084: * The synchronized method responsible for removing the session from the
085: * threads list.
086: *
087: * @exception SecurityException
088: */
089: public synchronized void removeSession(Long threadId)
090: throws SecurityException {
091: permissions.remove(threadId);
092: }
093:
094: /**
095: * This method returns the permission information for the current session
096: * identified by the thread making the call.
097: *
098: * @return The thread permission session object.
099: * @exception SecurityException
100: */
101: public ThreadPermissionSession getSession()
102: throws SecurityException {
103: Long threadId = new Long(Thread.currentThread().getId());
104: log.debug("Get session for [" + threadId + "]");
105: ThreadPermissionSession session = getSession(threadId);
106: if (session == null) {
107: throw new SecurityException(
108: "No session can be found for current thread.");
109: }
110: return session;
111: }
112:
113: /**
114: * This method pushes the role onto the thread session.
115: *
116: * @param roleName The name of the role to push onto the thread session.
117: * @exception SecurityException
118: */
119: public void pushRole(String roleName) throws SecurityException {
120: ThreadPermissionSession session = getSession();
121: Role role = RoleManager.getInstance().getRole(roleName);
122: if (role.canAccessRole(session.getPrincipals()) == false) {
123: throw new SecurityException(
124: "The session does not have the rights to these permissions");
125: }
126: session.addRole(role);
127: }
128:
129: /**
130: * Removed a role from the session.
131: *
132: * @param roleName The name of the role to remove from the session.
133: * @exception SecurityException
134: */
135: public void popRole(String roleName) throws SecurityException {
136: ThreadPermissionSession session = getSession();
137: Role role = RoleManager.getInstance().getRole(roleName);
138: session.removeRole(role);
139: }
140:
141: }
|