/*******************************************************************************
 * Copyright 2014 Federal Chancellery Austria
 * MOA-ID has been developed in a cooperation between BRZ, the Federal
 * Chancellery Austria - ICT staff unit, and Graz University of Technology.
 * 
 * Licensed under the EUPL, Version 1.1 or - as soon they will be approved by
 * the European Commission - subsequent versions of the EUPL (the "Licence");
 * You may not use this work except in compliance with the Licence.
 * You may obtain a copy of the Licence at:
 * http://www.osor.eu/eupl/
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the Licence is distributed on an "AS IS" basis,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Licence for the specific language governing permissions and
 * limitations under the Licence.
 * 
 * This product combines work with different licenses. See the "NOTICE" text
 * file for details on the various modules and licenses.
 * The "NOTICE" text file is part of the distribution. Any derivative works
 * that you distribute must include a readable copy of the "NOTICE" text file.
 ******************************************************************************/
/*
 * Copyright 2003 Federal Chancellery Austria
 * MOA-ID has been developed in a cooperation between BRZ, the Federal
 * Chancellery Austria - ICT staff unit, and Graz University of Technology.
 *
 * Licensed under the EUPL, Version 1.1 or - as soon they will be approved by
 * the European Commission - subsequent versions of the EUPL (the "Licence");
 * You may not use this work except in compliance with the Licence.
 * You may obtain a copy of the Licence at:
 * http://www.osor.eu/eupl/
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the Licence is distributed on an "AS IS" basis,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Licence for the specific language governing permissions and
 * limitations under the Licence.
 *
 * This product combines work with different licenses. See the "NOTICE" text
 * file for details on the various modules and licenses.
 * The "NOTICE" text file is part of the distribution. Any derivative works
 * that you distribute must include a readable copy of the "NOTICE" text file.
 */


package at.gv.egovernment.moa.id.auth.data;

import java.io.Serializable;

import at.gv.egovernment.moa.id.commons.api.data.ExtendedSAMLAttribute;

/**
 * This class contains SAML attributes to be appended to the SAML assertion delivered to
 * the Online application.
 * 
 * @author Harald Bratko
 */
public class ExtendedSAMLAttributeImpl implements ExtendedSAMLAttribute, Serializable{
  
  /**
	 * 
	 */
	private static final long serialVersionUID = 1L;

/**
   * The value of this SAML attribute. Must be either of type <code>java.lang.String</code>
   * or <code>org.w3c.Element</code>.
   */
  protected Object value_;
  
  /**
   * The name of this SAML attribute.
   */
  protected String name_;
  
  /**
   * The namespace URI of this SAML attribute.
   */
  protected String namespace_;
  
  /**
   * Specifies whether this SAML attribute should be appended to AUTH Block.
   */
  protected int addToAUTHBlock_;

  /**
   * Sets this ExtendedSAMLAttribute.
   * @param name            The name of this SAML Attribute.
   * @param value           The value of this SAML Attribute. Must be either of type
   *                        <code>java.lang.String</code> or <code>org.w3c.dom.Element</code>.
   * @param namespace       The namespace of this SAML Attribute.
   * @param addToAUTHBlock  Specifies if this SAML Attribute should be added to the AUTHBlock.
   *                        The following values are allowed:
   *        <ul>
   *            <li>
   *            {@link at.gv.egovernment.moa.id.commons.api.data.ExtendedSAMLAttribute#ADD_TO_AUTHBLOCK}
   *            </li>
   *            <li>
   *            {@link at.gv.egovernment.moa.id.commons.api.data.ExtendedSAMLAttribute#NOT_ADD_TO_AUTHBLOCK}
   *            </li>
   *            <li>
   *            {@link at.gv.egovernment.moa.id.commons.api.data.ExtendedSAMLAttribute#ADD_TO_AUTHBLOCK_ONLY}
   *            </li>
   *        </ul> 
   *                        
   */
  public ExtendedSAMLAttributeImpl(String name, Object value, String namespace, int addToAUTHBlock) {
    name_ = name;
    value_ = value;
    namespace_ = namespace;
    addToAUTHBlock_ = addToAUTHBlock;
  }

  /**
   * @see at.gv.egovernment.moa.id.commons.api.data.ExtendedSAMLAttribute#getValue()
   */
  public Object getValue() {
    return value_;
  }

  /**
   * @see at.gv.egovernment.moa.id.commons.api.data.ExtendedSAMLAttribute#getName()
   */
  public String getName() {
    return name_;
  }

  /**
   * @see at.gv.egovernment.moa.id.commons.api.data.ExtendedSAMLAttribute#getNameSpace()
   */
  public String getNameSpace() {
    return namespace_;
  }

  /**
   * @see at.gv.egovernment.moa.id.commons.api.data.ExtendedSAMLAttribute#getAddToAUTHBlock()
   */
  public int getAddToAUTHBlock() {
    return addToAUTHBlock_;
  }

  /**
   * Specifies if this SAML Attribute should be added to the AUTHBlock.
   *
   * @param addToAUTHBlock One of the following values:
   *        <ul>
   *            <li>
   *            {@link at.gv.egovernment.moa.id.commons.api.data.ExtendedSAMLAttribute#ADD_TO_AUTHBLOCK}
   *            </li>
   *            <li>
   *            {@link at.gv.egovernment.moa.id.commons.api.data.ExtendedSAMLAttribute#NOT_ADD_TO_AUTHBLOCK}
   *            </li>
   *            <li>
   *            {@link at.gv.egovernment.moa.id.commons.api.data.ExtendedSAMLAttribute#ADD_TO_AUTHBLOCK_ONLY}
   *            </li>
   *        </ul>
   *    {@link at.gv.egovernment.moa.id.commons.api.data.ExtendedSAMLAttribute#ADD_TO_AUTHBLOCK} 
   */
  public void setAddToAUTHBlock(int addToAUTHBlock) {
    addToAUTHBlock_ = addToAUTHBlock;
  }

  /**
   * Sets the name of this SAML attribute.
   *
   * @param name The name of this SAML attribute.
   */
  public void setName(String name) {
    name_ = name;
  }

  /**
   * Sets the namespace of this SAML attribute.
   *
   * @param namespace The namespace to set.
   */
  public void setNamespace(String namespace) {
    namespace_ = namespace;
  }

  /**
   * Sets the value of this SAML attribute.
   *
   * @param value The value of this SAML Attribute. Must be either of type
   *              <code>java.lang.String</code> or <code>org.w3c.dom.Element</code>.
   */
  public void setValue(Object value) {
    value_ = value;
  }

}