li.strolch.runtime.privilege.PrivilegeHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of agent Show documentation
Strolch Agent which is the runtime for Strolch
The newest version!
/*
 * Copyright 2013 Robert von Burg 
 *
 * 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.
 */
package li.strolch.runtime.privilege;

import li.strolch.privilege.base.PrivilegeException;
import li.strolch.privilege.handler.SystemAction;
import li.strolch.privilege.handler.SystemActionWithResult;
import li.strolch.privilege.model.Certificate;
import li.strolch.privilege.model.PrivilegeContext;
import li.strolch.privilege.model.Usage;
import li.strolch.runtime.StrolchConstants;

/**
 * The privilege handler for authenticating users and performing actions as a system user
 *
 * @author Robert von Burg 
 */
public interface PrivilegeHandler {

	/**
	 * Reloads the configuration, by re-initializing the underlying privilege handler
	 */
	void reloadConfiguration();

	/**
	 * Authenticate a user
	 *
	 * @param username
	 * 		the username
	 * @param password
	 * 		the password
	 *
	 * @return the certificate
	 *
	 * @see li.strolch.privilege.handler.PrivilegeHandler#authenticate(String, char[], boolean)
	 */
	Certificate authenticate(String username, char[] password);

	/**
	 * Authenticate a user
	 *
	 * @param username
	 * 		the username
	 * @param password
	 * 		the password
	 * @param source
	 * 		the source of the request
	 * @param usage
	 * 		the usage for this authentication
	 * @param keepAlive
	 * 		should this session be kept alive
	 *
	 * @return the certificate
	 *
	 * @see li.strolch.privilege.handler.PrivilegeHandler#authenticate(String, char[], boolean)
	 */
	Certificate authenticate(String username, char[] password, String source, Usage usage, boolean keepAlive);

	/**
	 * Authenticates a user on a remote Single Sign On service. This is implemented by the
	 *
	 * @param data
	 * 		the data to perform the SSO
	 *
	 * @return the {@link Certificate} for the user
	 *
	 * @throws PrivilegeException
	 * 		if something goes wrong with the SSO
	 */
	Certificate authenticateSingleSignOn(Object data) throws PrivilegeException;

	/**
	 * Authenticates a user on a remote Single Sign On service. This is implemented by the
	 *
	 * @param data
	 * 		the data to perform the SSO
	 * @param source
	 * 		the source of the request
	 *
	 * @return the {@link Certificate} for the user
	 *
	 * @throws PrivilegeException
	 * 		if something goes wrong with the SSO
	 */
	Certificate authenticateSingleSignOn(Object data, String source) throws PrivilegeException;

	/**
	 * Performs a refresh of the given certificate's session by returning a new certificate
	 *
	 * @param certificate
	 * 		the certificate to refresh
	 * @param source
	 * 		the source of the request
	 *
	 * @return certificate a new certificate
	 */
	Certificate refreshSession(Certificate certificate, String source);

	/**
	 * Return true if refreshing sessions is allowed
	 *
	 * @return true if refreshing sessions is allowed
	 */
	boolean isRefreshAllowed();

	/**
	 * Returns the {@link PrivilegeContext} for the given certificate
	 *
	 * @param certificate
	 * 		the certificate
	 *
	 * @return the {@link PrivilegeContext} for the given certificate
	 *
	 * @throws PrivilegeException
	 * 		if the certificate is not valid anymore
	 * @see li.strolch.privilege.handler.PrivilegeHandler#validate(li.strolch.privilege.model.Certificate)
	 */
	PrivilegeContext validate(Certificate certificate) throws PrivilegeException;

	/**
	 * Returns the {@link PrivilegeContext} for the given certificate
	 *
	 * @param certificate
	 * 		the certificate
	 * @param source
	 * 		the source of the request
	 *
	 * @return the {@link PrivilegeContext} for the given certificate
	 *
	 * @throws PrivilegeException
	 * 		if the certificate is not valid anymore
	 * @see li.strolch.privilege.handler.PrivilegeHandler#validate(li.strolch.privilege.model.Certificate)
	 */
	PrivilegeContext validate(Certificate certificate, String source) throws PrivilegeException;

	/**
	 * Validates that the given {@link PrivilegeContext} is still valid
	 *
	 * @param ctx
	 * 		the {@link PrivilegeContext} to validate
	 *
	 * @throws PrivilegeException
	 */
	void validateSystemSession(PrivilegeContext ctx) throws PrivilegeException;

	/**
	 * Invalidates the given certificate
	 *
	 * @param certificate
	 * 		the certificate
	 *
	 * @return true if the certificate was invalidated, or false if it was already invalidated
	 *
	 * @see li.strolch.privilege.handler.PrivilegeHandler#invalidate(li.strolch.privilege.model.Certificate)
	 */
	boolean invalidate(Certificate certificate);

	/**
	 * Notifies that the session has timed out, i.e. the certificate must be invalidated
	 *
	 * @param certificate
	 * 		the certificate that has timed out
	 *
	 * @return true if the certificate was invalidated, or false it was already invalidated
	 *
	 * @see li.strolch.privilege.handler.PrivilegeHandler#invalidate(li.strolch.privilege.model.Certificate)
	 */
	boolean sessionTimeout(Certificate certificate);

	/**
	 * Run the given {@link SystemAction} as the given system user
	 *
	 * @param username
	 * 		the system username
	 * @param action
	 * 		the action to perform
	 *
	 * @throws PrivilegeException
	 * 		if there is something wrong
	 * @throws Exception
	 * 		if anything else goes wrong during execution
	 */
	void runAs(String username, SystemAction action) throws PrivilegeException, Exception;

	/**
	 * Run the given {@link SystemActionWithResult} as the given system user
	 *
	 * @param username
	 * 		the system username
	 * @param action
	 * 		the action to perform
	 *
	 * @return the result
	 *
	 * @throws PrivilegeException
	 * 		if there is something wrong
	 * @throws Exception
	 * 		if anything else goes wrong during execution
	 */
	 T runWithResult(String username, SystemActionWithResult action) throws PrivilegeException, Exception;

	/**
	 * Run the given {@link PrivilegedRunnable} as the given system user
	 *
	 * @param username
	 * 		the system username
	 * @param runnable
	 * 		the runnable to perform
	 *
	 * @throws PrivilegeException
	 * 		if there is something wrong
	 * @throws Exception
	 * 		if anything else goes wrong during execution
	 */
	void runAs(String username, PrivilegedRunnable runnable) throws PrivilegeException, Exception;

	/**
	 * Run the given {@link PrivilegedRunnable} as the given system user
	 *
	 * @param username
	 * 		the system username
	 * @param runnable
	 * 		the runnable to perform
	 *
	 * @return the result
	 *
	 * @throws PrivilegeException
	 * 		if there is something wrong
	 * @throws Exception
	 * 		if anything else goes wrong during execution
	 */
	 T runWithResult(String username, PrivilegedRunnableWithResult runnable) throws PrivilegeException, Exception;

	/**
	 * Run the given {@link SystemAction} as the system user {@link StrolchConstants#SYSTEM_USER_AGENT}
	 *
	 * @param action
	 * 		the action to perform
	 *
	 * @throws PrivilegeException
	 * 		if there is something wrong
	 * @throws Exception
	 * 		if anything else goes wrong during execution
	 */
	void runAsAgent(SystemAction action) throws PrivilegeException, Exception;

	/**
	 * Run the given {@link SystemActionWithResult} as the system user {@link StrolchConstants#SYSTEM_USER_AGENT}
	 *
	 * @param action
	 * 		the action to perform
	 *
	 * @throws PrivilegeException
	 * 		if there is something wrong
	 * @throws Exception
	 * 		if anything else goes wrong during execution
	 */
	 T runAsAgentWithResult(SystemActionWithResult action) throws PrivilegeException, Exception;

	/**
	 * Run the given {@link PrivilegedRunnable} as the system user {@link StrolchConstants#SYSTEM_USER_AGENT}
	 *
	 * @param runnable
	 * 		the runnable to perform
	 *
	 * @throws PrivilegeException
	 * 		if there is something wrong
	 * @throws Exception
	 * 		if anything else goes wrong during execution
	 */
	void runAsAgent(PrivilegedRunnable runnable) throws PrivilegeException, Exception;

	/**
	 * Run the given {@link PrivilegedRunnableWithResult} as the system user {@link StrolchConstants#SYSTEM_USER_AGENT}
	 *
	 * @param runnable
	 * 		the runnable to perform
	 *
	 * @return the result
	 *
	 * @throws PrivilegeException
	 * 		if there is something wrong
	 * @throws Exception
	 * 		if anything else goes wrong during execution
	 */
	 T runAsAgentWithResult(PrivilegedRunnableWithResult runnable) throws PrivilegeException, Exception;

	/**
	 * Run the given {@link PrivilegedRunnableWithResult} as the given system user
	 *
	 * @param username
	 * 		the system username
	 * @param runnable
	 * 		the runnable to perform
	 *
	 * @return the result
	 *
	 * @throws PrivilegeException
	 * 		if there is something wrong
	 * @throws Exception
	 * 		if anything else goes wrong during execution
	 */
	 T runAsWithResult(String username, PrivilegedRunnableWithResult runnable)
			throws PrivilegeException, Exception;

	/**
	 * Opens a {@link PrivilegeContext} as the system user {@link StrolchConstants#SYSTEM_USER_AGENT}
	 *
	 * @throws PrivilegeException
	 * 		if there is something wrong
	 */
	PrivilegeContext openAgentSystemUserContext() throws PrivilegeException;

	/**
	 * Returns the {@link li.strolch.privilege.handler.PrivilegeHandler}
	 *
	 * @return the {@link li.strolch.privilege.handler.PrivilegeHandler}
	 */
	li.strolch.privilege.handler.PrivilegeHandler getPrivilegeHandler();
}