001/*
002 *  Copyright 2017 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.plugins.site.token;
017
018import org.apache.cocoon.environment.Request;
019
020/**
021 * Component responsible for extracting token from an incoming request.
022 */
023public interface GetToken
024{
025    /**
026     * Get an authentication token from the request, if any.
027     * @param request the current request.
028     * @return the token or null if it doesn't exist.
029     */
030    public String getToken(Request request);
031    
032    /**
033     * Get an authentication token context from the request, if any.
034     * @param request the current request.
035     * @return the token context or null if it doesn't exist.
036     */
037    public String getTokenContext(Request request);
038}