se.swedenconnect.opensaml.common.builder.SAMLObjectBuilder Maven / Gradle / Ivy

Go to download

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

OpenSAML 5.X utility extension library

The newest version!

/*
 * Copyright 2016-2024 Sweden Connect
 *
 * 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 se.swedenconnect.opensaml.common.builder;

import org.opensaml.core.xml.XMLObject;

/**
 * Interface for a builder pattern according to:
 *
 *  * EntityDescriptorBuilder builder = new EntityDescriptorBuilder();
 * EntityDescriptor ed = builder.entityID("http://eid.idsec.se").entityCategories(...)[...].build();
 * 
 *
 * @author Martin Lindström ([email protected])
 *
 * @param  the type
 */
public interface SAMLObjectBuilder {

  /**
   * Builds the {@code XMLObject}.
   * 
   * If invoked several times the method must return the same object.
   * 
   *
   * @return the built object
   */
  T build();

}