com.rathravane.clerk.identity.UserDataHolder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of clerk Show documentation

A framework for user identification, authentication, and access control.

The newest version!

/*-
 * #%L
 * Rathravane Clerk
 * %%
 * Copyright (C) 2006 - 2016 Rathravane LLC
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package com.rathravane.clerk.identity;

import java.util.Map;

import com.rathravane.clerk.exceptions.IamSvcException;

/**
 * A container for user-oriented data. In addition to being extended by Identity,
 * the Group interface can also hold user-oriented data.
 * 
 * @author peter
 *
 */
public interface UserDataHolder
{
	/**
	 * reload this object from the server
	 * @throws IamSvcException 
	 */
	void reload () throws IamSvcException;

	/**
	 * Get a named data value.
	 * @param key
	 * @return a value or null
	 * @throws IamSvcException
	 */
	String getUserData ( String key ) throws IamSvcException;

	/**
	 * Put a named data value.
	 * @param key
	 * @param val
	 * @throws IamSvcException
	 */
	void putUserData ( String key, String val ) throws IamSvcException;

	/**
	 * Remove a named data value.
	 */
	void removeUserData ( String key ) throws IamSvcException;

	/**
	 * Get all of the user data
	 * @return a map of user data
	 * @throws IamSvcException
	 */
	Map getAllUserData () throws IamSvcException;
}