IdentityServices.java revision 27121b5c17e206894afd6d337a5d7fc6e4e8bb27
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2007 Sun Microsystems Inc. All Rights Reserved
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the License at
* See the License for the specific language governing
* permission and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at opensso/legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* $Id: IdentityServices.java,v 1.5 2009/12/15 00:34:57 veiming Exp $
*
* Portions Copyrighted 2011-2015 ForgeRock AS.
*/
/**
* Base interface for all security providers.
*/
public interface IdentityServices extends Remote {
/**
* Retrieve user details (roles, attributes) for the subject.
*
* @param attributeNames Optional list of attributes to be returned.
* @param subject Token for subject.
* @return User details for the subject.
* @throws TokenExpired When Token has expired.
* @throws GeneralFailure On other errors.
* @throws AccessDenied If reading of attributes for the user is
* disallowed.
*/
UserDetails attributes(List attributeNames, Token subject, boolean refresh) throws TokenExpired, GeneralFailure,
/**
* Logs a message on behalf of the authenticated app.
*
* @param app Token corresponding to the authenticated application.
* @param subject Optional token identifying the subject for which the log
* record pertains.
* @param logName Identifier for the log file, e.g. "MyApp.access".
* @param message String containing the message to be logged.
* @throws AccessDenied If app token is not specified.
* @throws GeneralFailure On error.
*/
void log(Token app, Token subject, String logName, String message) throws AccessDenied, TokenExpired,
/**
* Retrieves an identity object matching input criteria.
*
* @param name The name of identity to retrieve.
* @param attributes Attribute objects specifying criteria for the object
* to retrieve.
* @param admin Token identifying the administrator to be used to authorize
* the request.
* @return IdentityDetails of the subject.
* @throws NeedMoreCredentials When more credentials are required for
* authorization.
* @throws ObjectNotFound If no subject is found that matches the input
* criteria.
* @throws TokenExpired When subject's token has expired.
* @throws GeneralFailure On other errors.
* @throws AccessDenied If reading of attributes for the user is
* disallowed.
*/
IdentityDetails read(String name, List attributes, Token admin) throws NeedMoreCredentials, ObjectNotFound,
/**
* Returns the cookie used by OpenAM Authentication module to store the
* SSOToken. Can be used for Single-Sign-On by replaying this cookie back
* to OpenAM for other operations.
*
* @return Cookie name that contains the SSOToken.
* @throws GeneralFailure On other errors.
*/
/**
* Returns a list of cookie names that are used by OpenAM for
* authentication and load balancing. Replaying all these cookies during
* the request is highly recommended.
*
* @return {@code true} If token is valid.
* @throws GeneralFailure On other errors.
*/
}