PrincipalPopulator.java

/*
 * Copyright (c) 2010 Lockheed Martin Corporation
 *
 * 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 org.eurekastreams.commons.actions.context;

/**
 * The PrincipalPopulator is responsible for populating the Principal object.
 *
 */
public interface PrincipalPopulator 
{
    /**
     * Retrieves a populated principal object for the current request.
     * @param inAccountId - String based account id for the Principal.
     * @param inSessionId - the session ID.
     * @return - instance of the Principal object.
     */
    Principal getPrincipal(final String inAccountId, final String inSessionId);
}