AbstractEndpointSelector.java

/*
 * Copyright [2007] [University Corporation for Advanced Internet Development, Inc.]
 *
 * 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.opensaml.common.binding;

import java.util.ArrayList;
import java.util.List;

import javax.xml.namespace.QName;

import org.opensaml.common.SAMLObject;
import org.opensaml.saml2.metadata.Endpoint;
import org.opensaml.saml2.metadata.EntityDescriptor;
import org.opensaml.saml2.metadata.RoleDescriptor;
import org.opensaml.saml2.metadata.provider.MetadataProvider;

/**
 * Endpoint selectors choose the endpoint that should be used to contact a peer.
 */
public abstract class AbstractEndpointSelector {

    /** Bindings supported by the issuer. */
    private List<String> supportedIssuerBindings;

    /** SAML request within the message flow. */
    private SAMLObject samlRequest;

    /** SAML response within the message flow. */
    private SAMLObject samlResponse;

    /** Provider of metadata for the relying party. */
    private MetadataProvider metadataProvider;

    /** Metadata of party to select endpoing for. */
    private EntityDescriptor entityMetadata;

    /** Role metadata of party to select endpoing for. */
    private RoleDescriptor entityRoleMetadata;

    /** Type of endpoint needed. */
    private QName endpointType;

    /** Constructor. */
    public AbstractEndpointSelector() {
        supportedIssuerBindings = new ArrayList<String>();
    }

    /**
     * Gets type of endpoint needed.
     * 
     * @return type of endpoint needed
     */
    public QName getEndpointType() {
        return endpointType;
    }

    /**
     * Sets the type of endpoint needed.
     * 
     * @param type type of endpoint needed
     */
    public void setEndpointType(QName type) {
        endpointType = type;
    }

    /**
     * Gets the metadata provider used to look up entity information.
     * 
     * @return metadata provider used to look up entity information
     */
    public MetadataProvider getMetadataProvider() {
        return metadataProvider;
    }

    /**
     * Sets the metadata provider used to look up entity information.
     * 
     * @param provider metadata provider used to look up entity information
     */
    public void setMetadataProvider(MetadataProvider provider) {
        metadataProvider = provider;
    }

    /**
     * Gets the metadata of the entity.
     * 
     * @return metadata of the entity
     */
    public EntityDescriptor getEntityMetadata() {
        return entityMetadata;
    }

    /**
     * Sets the metadata of the entity.
     * 
     * @param entity metadata of the entity
     */
    public void setEntityMetadata(EntityDescriptor entity) {
        entityMetadata = entity;
    }

    /**
     * Gets the role of the entity.
     * 
     * @return role of the entity
     */
    public RoleDescriptor getEntityRoleMetadata() {
        return entityRoleMetadata;
    }

    /**
     * Sets the role of the entity.
     * 
     * @param role role of the entity
     */
    public void setEntityRoleMetadata(RoleDescriptor role) {
        entityRoleMetadata = role;
    }

    /**
     * Gets the SAML request made.
     * 
     * @return SAML request made
     */
    public SAMLObject getSamlRequest() {
        return samlRequest;
    }

    /**
     * Sets the SAML request made.
     * 
     * @param request SAML request made
     */
    public void setSamlRequest(SAMLObject request) {
        samlRequest = request;
    }

    /**
     * Gets the response to the SAML request.
     * 
     * @return response to the SAML request
     */
    public SAMLObject getSamlResponse() {
        return samlResponse;
    }

    /**
     * Sets the response to the SAML request.
     * 
     * @param response response to the SAML request
     */
    public void setSamlResponse(SAMLObject response) {
        samlResponse = response;
    }

    /**
     * Gets the list of bindings supported by the message issuer.
     * 
     * @return list of bindings supported by the message issuer
     */
    public List<String> getSupportedIssuerBindings() {
        return supportedIssuerBindings;
    }

    /**
     * Selects the endpoint to which messages should be sent.
     * 
     * @return endpoint to which messages should be sent, or null if no suitable endpoint can be determined
     */
    public abstract Endpoint selectEndpoint();
}