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
020import org.ametys.runtime.plugin.component.AbstractThreadSafeComponentExtensionPoint;
021
022/**
023 * Extension point for components extracting token from an incoming request.
024 */
025public class GetTokenExtensionPoint extends AbstractThreadSafeComponentExtensionPoint<GetToken>
026{
027    /** Avalon Role */
028    public static final String ROLE = GetTokenExtensionPoint.class.getName();
029    
030    /**
031     * Returns the token from the request.
032     * @param request the incoming request.
033     * @return the extracted token, if any.
034     */
035    public String getToken(Request request)
036    {
037        for (String id : getExtensionsIds())
038        {
039            GetToken getToken = getExtension(id);
040            String token = getToken.getToken(request);
041            if (token != null)
042            {
043                return token;
044            }
045        }
046        
047        return null;
048    }
049    
050    /**
051     * Returns the token context from the request.
052     * @param request the incoming request.
053     * @return the extracted token context, if any.
054     */
055    public String getTokenContext(Request request)
056    {
057        for (String id : getExtensionsIds())
058        {
059            GetToken getToken = getExtension(id);
060            String tokenContext = getToken.getTokenContext(request);
061            if (tokenContext != null)
062            {
063                return tokenContext;
064            }
065        }
066        
067        return null;
068    }
069}