001: /**********************************************************************************
002: * $URL: https://source.sakaiproject.org/svn/authz/tags/sakai_2-4-1/authz-api/api/src/java/org/sakaiproject/authz/api/SecurityService.java $
003: * $Id: SecurityService.java 18600 2006-12-02 21:08:54Z ggolden@umich.edu $
004: ***********************************************************************************
005: *
006: * Copyright (c) 2003, 2004, 2005, 2006 The Sakai Foundation.
007: *
008: * Licensed under the Educational Community License, Version 1.0 (the "License");
009: * you may not use this file except in compliance with the License.
010: * You may obtain a copy of the License at
011: *
012: * http://www.opensource.org/licenses/ecl1.php
013: *
014: * Unless required by applicable law or agreed to in writing, software
015: * distributed under the License is distributed on an "AS IS" BASIS,
016: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017: * See the License for the specific language governing permissions and
018: * limitations under the License.
019: *
020: **********************************************************************************/package org.sakaiproject.authz.api;
021:
022: import java.util.Collection;
023: import java.util.List;
024:
025: import org.sakaiproject.user.api.User;
026:
027: /**
028: * <p>
029: * SecurityService is the interface for Sakai security services.
030: * </p>
031: */
032: public interface SecurityService {
033: /** This string can be used to find the service in the service manager. */
034: static final String SERVICE_NAME = SecurityService.class.getName();
035:
036: /**
037: * Can the current session user unlock the lock for use with this resource?
038: *
039: * @param lock
040: * The lock id string.
041: * @param reference
042: * The resource reference string.
043: * @return true, if the user can unlock the lock, false otherwise.
044: */
045: boolean unlock(String lock, String reference);
046:
047: /**
048: * Can the specificed user unlock the lock for use with this resource?
049: *
050: * @param user
051: * The user.
052: * @param lock
053: * The lock id string.
054: * @param reference
055: * The resource reference string.
056: * @return true, if the user can unlock the lock, false otherwise.
057: */
058: boolean unlock(User user, String lock, String reference);
059:
060: /**
061: * Can the specificed user id unlock the lock for use with this resource?
062: *
063: * @param userId
064: * The user id.
065: * @param lock
066: * The lock id string.
067: * @param reference
068: * The resource reference string.
069: * @return true, if the user can unlock the lock, false otherwise.
070: */
071: boolean unlock(String userId, String lock, String reference);
072:
073: /**
074: * Can the specificed user id unlock the lock for use with this resource (using these authzGroups for the check)?
075: *
076: * @param userId
077: * The user id.
078: * @param lock
079: * The lock id string.
080: * @param reference
081: * The resource reference string.
082: * @param authzGroupIds
083: * The set of authz group ids to use for the check (the reference is not consulted).
084: * @return true, if the user can unlock the lock, false otherwise.
085: */
086: boolean unlock(String userId, String lock, String reference,
087: Collection authzGroupIds);
088:
089: /**
090: * Access the List of Users who can unlock the lock for use with this resource.
091: *
092: * @param lock
093: * The lock id string.
094: * @param reference
095: * The resource reference string.
096: * @return A List (User) of the users can unlock the lock (may be empty).
097: */
098: List unlockUsers(String lock, String reference);
099:
100: /**
101: * Is this a super special super (admin) user?
102: *
103: * @return true, if the user is a cut above the rest, false if a mere mortal.
104: */
105: boolean isSuperUser();
106:
107: /**
108: * Is this user a super special super (admin) user?
109: *
110: * @param userId
111: * The user to test.
112: * @return true, if this user is a cut above the rest, false if a mere mortal.
113: */
114: boolean isSuperUser(String userId);
115:
116: /**
117: * Establish a new SecurityAdvisor for this thread, at the top of the stack (it gets first dibs on the answer).
118: *
119: * @param advisor
120: * The advisor to establish
121: */
122: void pushAdvisor(SecurityAdvisor advisor);
123:
124: /**
125: * Remove one SecurityAdvisor from the stack for this thread, if any exist.
126: *
127: * @return advisor The advisor popped of, or null if the stack is empty.
128: */
129: SecurityAdvisor popAdvisor();
130:
131: /**
132: * Check if there are any security advisors stacked for this thread.
133: *
134: * @return true if some advisors are defined, false if not.
135: */
136: boolean hasAdvisors();
137:
138: /**
139: * Remove any SecurityAdvisors from this thread.
140: */
141: void clearAdvisors();
142: }
|