xacml/policy/PolicyFactory.java

a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Copyright (c) 2007 Sun Microsystems Inc. All Rights Reserved
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The contents of this file are subject to the terms
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * of the Common Development and Distribution License
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * (the License). You may not use this file except in
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * compliance with the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * You can obtain a copy of the License at
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * opensso/legal/CDDLv1.0.txt
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * See the License for the specific language governing
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * permission and limitations under the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * When distributing Covered Code, include this CDDL
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Header Notice in each file and include the License file
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * at opensso/legal/CDDLv1.0.txt.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * If applicable, add the following below the CDDL Header,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * with the fields enclosed by brackets [] replaced by
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * your own identifying information:
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * "Portions Copyrighted [year] [name of copyright owner]"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * $Id: PolicyFactory.java,v 1.2 2008/06/25 05:48:14 qcheng Exp $
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpackage com.sun.identity.xacml.policy;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport org.w3c.dom.Element;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml2.common.SAML2Exception;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.xacml.common.XACMLException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.xacml.common.XACMLSDKUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.xacml.common.XACMLConstants;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.xacml.policy.impl.ObligationImpl;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.xacml.policy.impl.ObligationsImpl;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * This is the factory class to obtain instances of the objects defined
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * in xacml context schema.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * There are three ways to obtain an instance of a object type:
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * with no parameters, with a DOM tree element, or with an XML String.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @supported.all.api
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpublic class PolicyFactory {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private static PolicyFactory instance = new PolicyFactory();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Sole Constructor.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private PolicyFactory() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns the instance of <code>ContextSchemaFactory</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return <code>ContextSchemaFactory</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public static PolicyFactory getInstance() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return instance;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns a new instance of <code>Obligation</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return a new instance of <code>Obligation</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public Obligation createObligation() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        Object obj = XACMLSDKUtils.getObjectInstance(XACMLConstants.REQUEST);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (obj == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            return new ObligationImpl();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        } else {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            return (Obligation) obj;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns a new instance of <code>Obligation</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * The return object is immutable.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param elem a DOM Element representation of <code>Obligation</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return a new instance of <code>Obligation</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @throws XACMLException if error occurs while processing the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *    DOM Element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public Obligation createObligation(Element elem)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        throws XACMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        Object obj = XACMLSDKUtils.getObjectInstance(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            XACMLConstants.REQUEST, elem);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (obj == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            return new ObligationImpl(elem);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        } else {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            return (Obligation) obj;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns a new instance of <code>Obligation</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * The return object is immutable.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param xml a XML string representation of <code>Obligation</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return a new instance of <code>Resource</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @throws XACMLException if error occurs while processing the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *    XML string
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public Obligation createObligation(String xml)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        throws XACMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        Object obj = XACMLSDKUtils.getObjectInstance(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            XACMLConstants.REQUEST, xml);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (obj == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            return new ObligationImpl(xml);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        } else {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            return (Obligation) obj;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns a new instance of <code>Obligations</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return a new instance of <code>Obligations</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public Obligations createObligations() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        Object obj = XACMLSDKUtils.getObjectInstance(XACMLConstants.RESOURCE);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (obj == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            return new ObligationsImpl();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        } else {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            return (Obligations) obj;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns a new instance of <code>Obligations</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * The return object is immutable.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param elem a DOM Element representation of <code>Obligations</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return a new instance of <code>Obligations</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @throws XACMLException if error occurs while processing the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *    DOM Element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public Obligations createObligations(Element elem)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        throws XACMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        Object obj = XACMLSDKUtils.getObjectInstance(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            XACMLConstants.RESOURCE, elem);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (obj == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            return new ObligationsImpl(elem);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        } else {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            return (Obligations) obj;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns a new instance of <code>Obligations</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * The return object is immutable.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param xml a XML string representation of <code>Obligations</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return a new instance of <code>Obligations</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @throws XACMLException if error occurs while processing the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *    XML string
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public Obligations createObligations(String xml)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        throws XACMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        Object obj = XACMLSDKUtils.getObjectInstance(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            XACMLConstants.RESOURCE, xml);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (obj == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            return new ObligationsImpl(xml);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        } else {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            return (Obligations) obj;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster}