coordclientobject.java

一个完整的XACML工程,学习XACML技术的好例子!

/*
* Copyright (c) 2006, University of Kent
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without 
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this 
* list of conditions and the following disclaimer.
* 
* Redistributions in binary form must reproduce the above copyright notice, 
* this list of conditions and the following disclaimer in the documentation 
* and/or other materials provided with the distribution. 
*
* 1. Neither the name of the University of Kent nor the names of its 
* contributors may be used to endorse or promote products derived from this 
* software without specific prior written permission. 
*
* 2. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS  
* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
* PURPOSE ARE DISCLAIMED. 
*
* 3. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
* POSSIBILITY OF SUCH DAMAGE.
*
* 4. YOU AGREE THAT THE EXCLUSIONS IN PARAGRAPHS 2 AND 3 ABOVE ARE REASONABLE
* IN THE CIRCUMSTANCES.  IN PARTICULAR, YOU ACKNOWLEDGE (1) THAT THIS
* SOFTWARE HAS BEEN MADE AVAILABLE TO YOU FREE OF CHARGE, (2) THAT THIS
* SOFTWARE IS NOT "PRODUCT" QUALITY, BUT HAS BEEN PRODUCED BY A RESEARCH
* GROUP WHO DESIRE TO MAKE THIS SOFTWARE FREELY AVAILABLE TO PEOPLE WHO WISH
* TO USE IT, AND (3) THAT BECAUSE THIS SOFTWARE IS NOT OF "PRODUCT" QUALITY
* IT IS INEVITABLE THAT THERE WILL BE BUGS AND ERRORS, AND POSSIBLY MORE
* SERIOUS FAULTS, IN THIS SOFTWARE.
*
* 5. This license is governed, except to the extent that local laws
* necessarily apply, by the laws of England and Wales.
*/

/*
 * CoordObject.java
 *
 * Created on 11 July 2006, 12:09
 *
 * To change this template, choose Tools | Template Manager
 * and open the template in the editor.
 */

package uk.ac.kent.dpa.coord.clients;

import org.apache.axis.message.addressing.Address;
import org.apache.axis.message.addressing.EndpointReferenceType;
import org.w3c.dom.Element;
import org.globus.stubs.CoordService_instance.*;
import org.globus.stubs.CoordService_instance.service.CoordServiceAddressingLocator;
import java.util.*;
import uk.ac.kent.dpa.util.*;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import issrg.web.service.EncodeXML;
/**
 *
 * @author ls97
 */
public class CoordClientObject {
     
    private String serviceURI;
    static Log logger = LogFactory.getLog(CoordClientObject.class.getName());

    /** Creates a new instance of CoordObject */
    
    
    public CoordClientObject(String uriIn) throws CoordClientException {
        if (uriIn==null) throw new CoordClientException("the service URI must be set");
        this.serviceURI = uriIn;
    }
    
 /**
  * @param String attrName name of the coordination attribute
  * @param int type, the type lof lock (READ=0, WRITE=1)
  * @return String the value of the coordination attribute
  **/ 
    
    public boolean lockCoordAttrs(String[] attributes, int[] types) throws CoordClientException {
        if (attributes.length!=types.length) throw new CoordClientException("invalid lock parameters");
        CoordServiceAddressingLocator locator = new CoordServiceAddressingLocator();
        try {
                Element element = null;
                // Create endpoint reference to service
                EndpointReferenceType endpoint = new EndpointReferenceType();
                endpoint.setAddress(new Address(this.serviceURI));
                CoordPortType coord = locator.getCoordPortTypePort(endpoint);
                LockComposer[] composers = this.getLockParams(attributes,types);
                for (int i=0;i<composers.length;i++) {
                    String url = composers[i].getDbURL();
                    String param = composers[i].compose();
                    LockAll lock = new LockAll(url,param);
                    logger.debug("lock");
                    logger.debug(url+":"+param);
                    coord.lockAll(lock);
                }
                return true;
        } catch (Exception e) {
                throw new CoordClientException("failure to create a WS-Resource as a coordination object "+e);
        }        
    }

    public boolean unlockCoordAttrs(String[] attributes) throws CoordClientException {
        CoordServiceAddressingLocator locator = new CoordServiceAddressingLocator();
        try {
                Element element = null;
                // Create endpoint reference to service
                EndpointReferenceType endpoint = new EndpointReferenceType();
                endpoint.setAddress(new Address(this.serviceURI));
                CoordPortType coord = locator.getCoordPortTypePort(endpoint);
                logger.debug("unlock");
                String names = new String();
                for (int i=0; i<attributes.length; i++) {
                    names += attributes[i];
                    if (i<attributes.length-1) names += ",";
                    //if (attributes[i].equals(this.getCoordTableName())) continue;
                    coord.unlock(attributes[i]);
                }
                logger.debug(names);
                return true;
        } catch (Exception e) {
                throw new CoordClientException("failure to create a WS-Resource as a coordination object "+e);
        }        
    }
 /**
  * @param String attrName name of the coordination attribute
  * @param Element reqCtx a XACML request context to accommodate defining attributes
  * @return String the value of the coordination attribute
  **/ 
    
    public String getCoordAttrVal(String attribute, Element reqCtx) throws CoordClientException {
        logger.debug("to get "+attribute+" in the data base");
        CoordServiceAddressingLocator locator = new CoordServiceAddressingLocator();
        try {
                EndpointReferenceType endpoint = new EndpointReferenceType();
                endpoint.setAddress(new Address(this.serviceURI));
                CoordPortType coord = locator.getCoordPortTypePort(endpoint);
                Get get = new Get(attribute,reqCtx);
                return coord.get(get);
        } catch (Exception e) {
                throw new CoordClientException("failure to get a WS-Resource as the coordination data "+e);
        }        
    }
    
    public void setCoordAttrVal(String attribute,String dataType,String value,Element reqCtx) throws CoordClientException {
        logger.debug("to update "+attribute+" in the data base");
        CoordServiceAddressingLocator locator = new CoordServiceAddressingLocator();
        try {
                // Create endpoint reference to service
                EndpointReferenceType endpoint = new EndpointReferenceType();
                endpoint.setAddress(new Address(this.serviceURI));
                CoordPortType coord = locator.getCoordPortTypePort(endpoint);
                org.globus.stubs.CoordService_instance.Set set = new org.globus.stubs.CoordService_instance.Set(attribute,dataType,reqCtx,value);
                coord.set(set);
        } catch (Exception e) {
                throw new CoordClientException("failure to create a WS-Resource as a coordination object "+e);
        }
    }
    
    /**
     * to check whether the WS-Resource for coordination is properly initialised with
     * setting a db configuration file name and a coordination attribute description table name
     * @ return true, which indicates it is properly set,
     * otherwise, it is not.
     */
    
    public boolean checkWS() throws CoordClientException {
        CoordServiceAddressingLocator locator = new CoordServiceAddressingLocator();
        try {
                Element element = null;
                // Create endpoint reference to service
                EndpointReferenceType endpoint = new EndpointReferenceType();
                endpoint.setAddress(new Address(this.serviceURI));
                CoordPortType coord = locator.getCoordPortTypePort(endpoint);
                // update the Value property of the resource, which will be the current coordination value
                String s1 = coord.getConfigRP(new GetConfigRP());
                String s2 = coord.getCadtRP(new GetCadtRP());
                if (s1.equals("NONE") || s2.equals("NONE")) return false;
                else return true;
        } catch (Exception e) {
                throw new CoordClientException("failure to access to a WS-Resource"+e);
        }
    }
    
    private LockComposer[] getLockParams(String[] attrs, int[] types) throws CoordClientException {
        ArrayList dbURLs = new ArrayList();
        for (int i=0; i<attrs.length; i++) {
            String name = attrs[i];
            String dbURL;
            int index1 = name.indexOf("//");
            int index2 = name.lastIndexOf("/");
            if (index2-index1>2) dbURL = name.substring(index1,index2);
            else dbURL = new String("//localhost:3306");
            DbInclude include = this.exist(dbURLs,dbURL);
            LockAndType lock = new LockAndType(attrs[i],types[i]);
            if (include!=null) {
               include.addMember(lock);
            } else {
                include = new DbInclude(dbURL);
                include.addMember(lock);
                dbURLs.add(include);
            }
        }
        LockComposer[] composers = new LockComposer[dbURLs.size()];
        int counter = 0;
        for (Iterator i=dbURLs.iterator();i.hasNext();) {
            DbInclude include = (DbInclude)i.next();
            String[] attributes = new String[include.getMembers().size()];
            int[] locktypes = new int[include.getMembers().size()];
            ArrayList pairs = include.getMembers();
            int c=0;
            for (Iterator j=pairs.iterator();j.hasNext();) {
                LockAndType lock = (LockAndType)j.next();
                attributes[c]=lock.getName();
                locktypes[c]=lock.getType();
                c++;
            }
            composers[counter] = new LockComposer(include.getDbURL(),attributes,locktypes);
            counter++;
        }
        return composers;
    }
    
    private DbInclude exist(ArrayList list, String name) {
        for (Iterator i=list.iterator();i.hasNext();) {
            DbInclude include = (DbInclude)i.next();
            if (name.equals(include.getDbURL())) return include;
        }
        return null;
    }
    
    public boolean isCoordAttr(String name) throws CoordClientException {
        CoordServiceAddressingLocator locator = new CoordServiceAddressingLocator();
        try {
                // Create endpoint reference to service
                EndpointReferenceType endpoint = new EndpointReferenceType();
                endpoint.setAddress(new Address(this.serviceURI));
                CoordPortType coord = locator.getCoordPortTypePort(endpoint);
                return coord.isCoord(name);
        } catch (Exception e) {
                throw new CoordClientException("failure to get a WS-Resource as the coordination data "+e);
        }
    }
    
    public Element getAttributeDefinition(String name) throws CoordClientException {
        CoordServiceAddressingLocator locator = new CoordServiceAddressingLocator();
        try {
                // Create endpoint reference to service
                EndpointReferenceType endpoint = new EndpointReferenceType();
                endpoint.setAddress(new Address(this.serviceURI));
                CoordPortType coord = locator.getCoordPortTypePort(endpoint);
                return coord.getAttributeDefinition(name);
        } catch (Exception e) {
                throw new CoordClientException("failure to get a WS-Resource as the coordination data "+e);
        }
    }
    
    public Element obligationEngine(Element obligations, Element reqCtx) throws CoordClientException  {
        CoordServiceAddressingLocator locator = new CoordServiceAddressingLocator();
        try {
                // Create endpoint reference to service
                EndpointReferenceType endpoint = new EndpointReferenceType();
                endpoint.setAddress(new Address(this.serviceURI));
                CoordPortType coord = locator.getCoordPortTypePort(endpoint);
                Execute obl = new Execute(obligations,reqCtx);
                logger.debug(new EncodeXML().encode(obligations,0));
                return coord.execute(obl);
        } catch (Exception e) {
                throw new CoordClientException("failure to get a WS-Resource as the coordination data "+e);
        }        
    }
    
    public String getCoordTableName() throws CoordClientException {
        CoordServiceAddressingLocator locator = new CoordServiceAddressingLocator();
        try {
                // Create endpoint reference to service
                EndpointReferenceType endpoint = new EndpointReferenceType();
                endpoint.setAddress(new Address(this.serviceURI));
                CoordPortType coord = locator.getCoordPortTypePort(endpoint);
                GetCadtRP get = new GetCadtRP();
                return coord.getCadtRP(get);
        } catch (Exception e) {
                throw new CoordClientException("failure to get a WS-Resource as the coordination data "+e);
        }   
    }
}