com.liferay.portal.security.sso.token.security.auth.TokenRetriever Maven / Gradle / Ivy
/**
* Copyright (c) 2000-present Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.portal.security.sso.token.security.auth;
import javax.servlet.http.HttpServletRequest;
/**
* Defines the public interface for authentication token location
* implementations.
*
*
* Custom TokenRetriever classes can override these default
* implementations:
*
*
*
* -
* {@link
* com.liferay.portal.security.sso.token.internal.security.auth.RequestTokenRetriever}
*
* -
* {@link com.liferay.portal.security.sso.token.internal.security.auth.Request
* HeaderTokenRetriever}
*
* -
* {@link
* com.liferay.portal.security.sso.token.internal.security.auth.CookieTokenRetriever}
*
* -
* {@link
* com.liferay.portal.security.sso.token.internal.security.auth.SessionTokenRetriever}
*
*
*
* @author Michael C. Han
*/
public interface TokenRetriever {
public String getLoginToken(
HttpServletRequest request, String userTokenName);
}