org.opensaml.saml.ext.saml2mdrpi.RegistrationInfo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opensaml-saml-api Show documentation
The newest version!
/*
 * 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.saml.ext.saml2mdrpi;

import java.time.Instant;
import java.util.List;

import javax.xml.XMLConstants;
import javax.xml.namespace.QName;

import org.opensaml.saml.common.SAMLObject;
import org.opensaml.saml.common.xml.SAMLConstants;

/**
 * Representation of the <mdrpi:RegistrationInfo> element.
 *
 * @see http://docs.oasis-open.org/security
 * /saml/Post2.0/saml-metadata-rpi/v1.0/
 */
public interface RegistrationInfo extends SAMLObject {

    /** Name of the element inside the Extensions. */
    public static final String DEFAULT_ELEMENT_LOCAL_NAME = "RegistrationInfo";

    /** Default element name. */
    public static final QName DEFAULT_ELEMENT_NAME = new QName(SAMLConstants.SAML20MDRPI_NS, DEFAULT_ELEMENT_LOCAL_NAME,
            SAMLConstants.SAML20MDRPI_PREFIX);

    /** Local name of the XSI type. */
    public static final String TYPE_LOCAL_NAME = "RegistrationInfoType";

    /** QName of the XSI type. */
    public static final QName TYPE_NAME =
            new QName(SAMLConstants.SAML20MDRPI_NS, TYPE_LOCAL_NAME, SAMLConstants.SAML20MDRPI_PREFIX);

    /** registrationAuthority attribute name. */
    public static String REGISTRATION_AUTHORITY_ATTRIB_NAME = "registrationAuthority";

    /** registrationInstant attribute name. */
    public static String REGISTRATION_INSTANT_ATTRIB_NAME = "registrationInstant";

    /** QName of the registrationInstant attribute. */
    public static final QName REGISTRATION_INSTANT_ATTRIB_QNAME =
            new QName(null, REGISTRATION_INSTANT_ATTRIB_NAME, XMLConstants.DEFAULT_NS_PREFIX);
    
    /**
     * Get the registration authority.
     * 
     * @return the registration authority
     */
    public String getRegistrationAuthority();

    /**
     * Set the registration authority.
     * 
     * @param authority the registration authority
     */
    public void setRegistrationAuthority(String authority);

    /**
     * Get the registration instant.
     * 
     * @return the registration instant
     */
    public Instant getRegistrationInstant();

    /**
     * Set the registration instant.
     * 
     * @param dateTime the instant
     */
    public void setRegistrationInstant(Instant dateTime);

    /**
     * Get the {@link RegistrationPolicy}s.
     * 
     * @return the list of policies
     */
    public List getRegistrationPolicies();

}