ClaimsMapper.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you 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.apache.cxf.sts.claims;

/**
 * This interface defines a pluggable way of mapping claims from a source realm to a target
 * realm.
 */
public interface ClaimsMapper {

    /**
     * Map a collection of claims in the source realm to the target realm
     * @param sourceRealm the source realm of the Principal
     * @param sourceClaims the claims collection in the source realm
     * @param targetRealm the target realm of the Principal
     * @return claims collection of the target realm
     */
    ProcessedClaimCollection mapClaims(String sourceRealm,
            ProcessedClaimCollection sourceClaims, String targetRealm, ClaimsParameters parameters);

}