TokenAuthorizer.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 net.formio.security;

/**
 * Allows authorization by validation of a token
 * generated using a shared secret. Implementations must be immutable.
 * @author Radek Beran
 */
public interface TokenAuthorizer {
	
	/**
	 * Generates token from given secret.
	 * @param secret
	 * @return generated token
	 */
	String generateToken(String secret);
	
	/**
	 * Returns true if and only if the given token is valid (was created using given secret).
	 * @param token
	 * @param secret
	 * @return true if token is valid
	 */
	boolean isValidToken(String token, String secret);
	
	/**
	 * Validates given token.
	 * @param token
	 * @param secret
	 * @throws InvalidTokenException if given token is not valid.
	 */
	void validateToken(String token, String secret);
	
}