ActionImpl.java revision a688bcbb4bcff5398fdd29b86f83450257dc0df4
/**
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the License at
* See the License for the specific language governing
* permission and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at opensso/legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* $Id: ActionImpl.java,v 1.2 2008/06/25 05:47:42 qcheng Exp $
*
*/
/**
* This class is an implementation of interface <code>Action</code>.
* The <code>Action</code> element specifies an action on the specified
* resource for which permission is sought. Its type is <code>ActionType</code>.
* <p>
* <pre>
* <complexType name="ActionType">
* <simpleContent>
* <extension base="<http://www.w3.org/2001/XMLSchema>string">
* <attribute name="Namespace" use="required"
* type="{http://www.w3.org/2001/XMLSchema}anyURI" />
* </extension>
* </simpleContent>
* </complexType>
* </pre>
*
*/
public class ActionImpl implements Action {
private boolean mutable = true;
// used by constructors
throws SAML2Exception
{
// make sure that the input xml block is not null
" Input is null.");
throw new SAML2Exception(
}
// Make sure this is an Action.
throw new SAML2Exception(
}
// handle the attribute of <Action> element
}
}
"Namespace is empty or missing.");
}
throw new SAML2Exception(
}
//handle the children elements of <Action>
if (nodeCount > 0) {
for (int i = 0; i < nodeCount; i++) {
+ "Illegal value of the element.");
}
throw new SAML2Exception(
}
}
}
// check if the action is null.
"Action value is null or empty.");
}
throw new SAML2Exception(
}
mutable = false;
}
/**
* Class constructor. Caller may need to call setters to populate the
* object.
*/
public ActionImpl() {
}
/**
* Class constructor with <code>Action</code> in <code>Element</code>
* format.
*/
throws SAML2Exception
{
}
/**
* Class constructor with <code>Action</code> in xml string format.
*/
throws SAML2Exception
{
throw new SAML2Exception(
}
}
/**
* Makes the object immutable.
*/
public void makeImmutable() {
mutable = false;
}
/**
* Returns the mutability of the object.
*
* @return true if the object is mutable; false otherwise.
*/
public boolean isMutable() {
return mutable;
}
/**
* Returns the value of the value property.
*
* @return A String label for the action.
* @see #setValue(String)
*/
return action;
}
/**
* Sets the value of the value property.
*
* @param value A String lable for the action to be set.
* @throws SAML2Exception if the object is immutable.
* @see #getValue()
*/
throws SAML2Exception
{
if (!mutable) {
throw new SAML2Exception(
}
}
/**
* Returns the value of the <code>Namespace</code> property.
*
* @return A String representing <code>Namespace</code> attribute.
* @see #setNamespace(String)
*/
public String getNamespace() {
return namespace;
}
/**
* Sets the value of the <code>Namespace</code> property.
*
* @param value A String representing <code>Namespace</code> attribute.
* @throws SAML2Exception if the object is immutable.
* @see #getNamespace()
*/
throws SAML2Exception
{
if (!mutable) {
throw new SAML2Exception(
}
}
/**
* Returns a String representation of the element.
*
* @return A string containing the valid XML for this element.
* By default name space name is prepended to the element name.
* @throws SAML2Exception if the object does not conform to the schema.
*/
public String toXMLString()
throws SAML2Exception
{
return this.toXMLString(true, false);
}
/**
* Returns a String representation of the element.
*
* @param includeNS Determines whether or not the namespace qualifier is
* prepended to the Element when converted
* @param declareNS Determines whether or not the namespace is declared
* within the Element.
* @return A string containing the valid XML for this element
* @throws SAML2Exception if the object does not conform to the schema.
*/
throws SAML2Exception
{
// validate the data before output the string
"Action value is null or empty.");
}
throw new SAML2Exception(
}
"Namespace is empty or missing");
}
throw new SAML2Exception(
}
if (includeNS) {
}
if (declareNS) {
}
append("\">");
}
}