org.opensaml.profile.action.MessageEncoderFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opensaml-profile-api Show documentation

There is a newer version: 4.0.1

/*
 * Licensed to the University Corporation for Advanced Internet Development, 
 * Inc. (UCAID) under one or more contributor license agreements.  See the 
 * NOTICE file distributed with this work for additional information regarding
 * copyright ownership. The UCAID 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.opensaml.profile.action;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import org.opensaml.messaging.encoder.MessageEncoder;
import org.opensaml.profile.context.ProfileRequestContext;

/**
 * A component that returns a {@link MessageEncoder} instance based on the content of a profile request
 * context.
 */
public interface MessageEncoderFactory {
    
    /**
     * Get the {@link MessageEncoder} to use.
     * 
     * @param profileRequestContext current profile request context
     * 
     * @return  the encoder to use, or null
     */
    @Nullable MessageEncoder getMessageEncoder(@Nonnull final ProfileRequestContext profileRequestContext);
    
}