org.apache.cxf.rs.security.oauth2.provider.SessionAuthenticityTokenProvider Maven / Gradle / Ivy
/**
* 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 org.apache.cxf.rs.security.oauth2.provider;
import org.apache.cxf.jaxrs.ext.MessageContext;
/**
* SessionAuthenticityTokenProvider responsible for storing and retrieving tokens
* to validate the authenticity of request sessions
*/
public interface SessionAuthenticityTokenProvider {
/**
* Creates a new session token and stores it
*
* @param mc the {@link MessageContext} of this request
* @return the created session token
*/
String createSessionToken(MessageContext mc);
/**
* Retrieves the stored session token
*
* @param mc the {@link MessageContext} of this request
* @return the stored token
*/
String getSessionToken(MessageContext mc);
/**
* Removes the stored session token
*
* @param mc the {@link MessageContext} of this request
*/
String removeSessionToken(MessageContext mc);
}