se.litsec.opensaml.saml2.common.request.RequestGenerator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opensaml3-ext Show documentation

OpenSAML 3.X utility extension library

There is a newer version: 1.4.5

/*
 * The opensaml-ext project is an open-source package that extends OpenSAML
 * with useful extensions and utilities.
 *
 * More details on 
 * Copyright (C) 2017 Litsec AB
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see .
 */
package se.litsec.opensaml.saml2.common.request;

import org.opensaml.saml.saml2.core.RequestAbstractType;

import se.litsec.opensaml.saml2.metadata.PeerMetadataResolver;

/**
 * Base interface for a SAML request generator.
 * 
 * @param 
 *          the request type
 * @param 
 *          the type of the input required by this generator
 * 
 * @author Martin Lindström ([email protected])
 */
public interface RequestGenerator {

  /**
   * Generates a SAML request message.
   * 
   * @param input
   *          the request input
   * @param metadataResolver
   *          resolver for finding the metadata for the receiving entity
   * @return a request object
   * @throws RequestGenerationException
   *           for errors during request generation
   */
  RequestHttpObject generateRequest(I input, PeerMetadataResolver metadataResolver) throws RequestGenerationException;

  /**
   * Returns the entityID for the Service Provider this request generator is serving.
   * 
   * @return the entityID
   */
  String getEntityID();

  /**
   * Returns the display name (for logging etc).
   * 
   * @return the name
   */
  String getName();

}