woko.users.UsernameResolutionStrategy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of woko-core Show documentation

The newest version!

/*
 * Copyright 2001-2012 Remi Vankeisbelck
 *
 * Licensed 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 woko.users;

import javax.servlet.http.HttpServletRequest;

/**
 * Strategy interface for retrieving the username from the request. Allows
 * for various implementations (cookie, session, remote user...) and full user session
 * pluggability.
 */
public interface UsernameResolutionStrategy {

    /**
     * Return the username (if any : return null for unauthenticated users) for passed request
     * @param request the request
     * @return the username if found (user already authenticated), or null if there is no authenticated user for the request
     */
    String getUsername(HttpServletRequest request);

}