Java tutorial
//====================================================================================== // Copyright 5AM Solutions Inc, Yale University // // Distributed under the OSI-approved BSD 3-Clause License. // See http://ncip.github.com/caarray/LICENSE.txt for details. //====================================================================================== package gov.nih.nci.cagrid.caarray.service.globus.resource; import gov.nih.nci.cagrid.advertisement.AdvertisementClient; import gov.nih.nci.cagrid.advertisement.exceptions.UnregistrationException; import gov.nih.nci.cagrid.caarray.common.CaArraySvcConstants; import gov.nih.nci.cagrid.caarray.stubs.CaArraySvcResourceProperties; import gov.nih.nci.cagrid.common.Utils; import gov.nih.nci.cagrid.introduce.servicetools.ReflectionResource; import java.io.File; import java.io.IOException; import java.net.URL; import javax.naming.Context; import javax.naming.InitialContext; import javax.xml.namespace.QName; import org.apache.axis.MessageContext; import org.apache.axis.message.MessageElement; import org.apache.axis.message.addressing.EndpointReferenceType; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.globus.mds.aggregator.types.AggregatorConfig; import org.globus.mds.aggregator.types.AggregatorContent; import org.globus.mds.aggregator.types.GetMultipleResourcePropertiesPollType; import org.globus.mds.servicegroup.client.ServiceGroupRegistrationParameters; import org.globus.wsrf.Constants; import org.globus.wsrf.Resource; import org.globus.wsrf.ResourceContext; import org.globus.wsrf.ResourceContextException; import org.globus.wsrf.ResourceException; import org.globus.wsrf.ResourceProperty; import org.globus.wsrf.config.ContainerConfig; import org.globus.wsrf.container.ServiceHost; import org.globus.wsrf.encoding.DeserializationException; import org.globus.wsrf.encoding.ObjectDeserializer; import org.globus.wsrf.impl.security.descriptor.ResourceSecurityDescriptor; import org.globus.wsrf.impl.servicegroup.client.ServiceGroupRegistrationClient; import org.globus.wsrf.security.SecureResource; import org.globus.wsrf.utils.AddressingUtils; /** * DO NOT EDIT: This class is autogenerated! * * This class is the base class of the resource type created for this service. * It contains accessor and utility methods for managing any resource properties * of these resource as well as code for registering any properties selected * to the index service. * * @created by Introduce Toolkit version 1.2 * */ public abstract class CaArraySvcResourceBase extends ReflectionResource implements Resource, SecureResource { static final Log logger = LogFactory.getLog(CaArraySvcResourceBase.class); private CaArraySvcResourceConfiguration configuration; private ResourceSecurityDescriptor desc; // this can be used to cancel the registration renewal private AdvertisementClient registrationClient; private URL baseURL; private boolean beingLoaded = false; public CaArraySvcResourceBase() { } /** * @see org.globus.wsrf.jndi.Initializable#initialize() */ public void initialize(Object resourceBean, QName resourceElementQName, Object id) throws ResourceException { // Call the super initialize on the ReflectionResource super.initialize(resourceBean, resourceElementQName, id); this.desc = null; // this loads the metadata from XML files if this is the main service populateResourceProperties(); // register the service to the index service refreshRegistration(true); } //Getters/Setters for ResourceProperties public gov.nih.nci.cagrid.metadata.ServiceMetadata getServiceMetadata() { return ((CaArraySvcResourceProperties) getResourceBean()).getServiceMetadata(); } public void setServiceMetadata(gov.nih.nci.cagrid.metadata.ServiceMetadata serviceMetadata) throws ResourceException { ResourceProperty prop = getResourcePropertySet().get(CaArraySvcConstants.SERVICEMETADATA); prop.set(0, serviceMetadata); } public gov.nih.nci.cagrid.metadata.dataservice.DomainModel getDomainModel() { return ((CaArraySvcResourceProperties) getResourceBean()).getDomainModel(); } public void setDomainModel(gov.nih.nci.cagrid.metadata.dataservice.DomainModel domainModel) throws ResourceException { ResourceProperty prop = getResourcePropertySet().get(CaArraySvcConstants.DOMAINMODEL); prop.set(0, domainModel); } /** * Sets the security descriptor for this resource. The default resource * security will be null so it will fall back to method level then service * level security. If you want to protect this particular instance of this * resource then provide a resource security descriptor to this resource * through this method. */ public void setSecurityDescriptor(ResourceSecurityDescriptor desc) { this.desc = desc; } public ResourceSecurityDescriptor getSecurityDescriptor() { return this.desc; } public CaArraySvcResourceConfiguration getConfiguration() { if (this.configuration != null) { return this.configuration; } MessageContext ctx = MessageContext.getCurrentContext(); String servicePath = ctx.getTargetService(); servicePath = servicePath.substring(0, servicePath.lastIndexOf("/")); servicePath += "/CaArraySvc"; String jndiName = Constants.JNDI_SERVICES_BASE_NAME + servicePath + "/configuration"; logger.debug("Will read configuration from jndi name: " + jndiName); try { Context initialContext = new InitialContext(); this.configuration = (CaArraySvcResourceConfiguration) initialContext.lookup(jndiName); } catch (Exception e) { logger.error("when performing JNDI lookup for " + jndiName + ": " + e, e); } return this.configuration; } /** * This checks the configuration file, and attempts to register to the * IndexService if shouldPerformRegistration==true. It will first read the * current container URL, and compare it against the saved value. If the * value exists, it will only try to reregister if the values are different. * This exists to handle fixing the registration URL which may be incorrect * during initialization, then later corrected during invocation. The * existence of baseURL does not imply successful registration (a non-null * registrationClient does). We will only attempt to reregister when the URL * changes (to prevent attempting registration with each invocation if there * is a configuration problem). */ public void refreshRegistration(boolean forceRefresh) { if (getConfiguration().shouldPerformRegistration()) { // first check to see if there are any resource properties that // require registration ResourceContext ctx; try { MessageContext msgContext = MessageContext.getCurrentContext(); if (msgContext == null) { logger.error("Unable to determine message context!"); return; } ctx = ResourceContext.getResourceContext(msgContext); } catch (ResourceContextException e) { logger.error("Could not get ResourceContext: " + e, e); return; } EndpointReferenceType epr; try { // since this is a singleton, pretty sure we dont't want to // register the key (allows multiple instances of same service // on successive restarts) epr = AddressingUtils.createEndpointReference(ctx, null); } catch (Exception e) { logger.error("Could not form EPR: " + e, e); return; } ServiceGroupRegistrationParameters params = null; File registrationFile = new File(ContainerConfig.getBaseDirectory() + File.separator + getConfiguration().getRegistrationTemplateFile()); if (registrationFile.exists() && registrationFile.canRead()) { logger.debug("Loading registration argumentsrmation from:" + registrationFile); try { params = ServiceGroupRegistrationClient.readParams(registrationFile.getAbsolutePath()); } catch (Exception e) { logger.error("Unable to read registration file:" + registrationFile, e); } // set our service's EPR as the registrant, or use the specified // value EndpointReferenceType registrantEpr = params.getRegistrantEPR(); if (registrantEpr == null) { params.setRegistrantEPR(epr); } } else { logger.error("Unable to read registration file:" + registrationFile); } if (params != null) { AggregatorContent content = (AggregatorContent) params.getContent(); AggregatorConfig config = content.getAggregatorConfig(); MessageElement[] elements = config.get_any(); GetMultipleResourcePropertiesPollType pollType = null; try { pollType = (GetMultipleResourcePropertiesPollType) ObjectDeserializer.toObject(elements[0], GetMultipleResourcePropertiesPollType.class); } catch (DeserializationException e1) { // TODO Auto-generated catch block e1.printStackTrace(); } if (pollType != null) { // if there are properties names that need to be registered then // register them to the index service if (pollType.getResourcePropertyNames() != null && pollType.getResourcePropertyNames().length != 0) { URL currentContainerURL = null; try { currentContainerURL = ServiceHost.getBaseURL(); } catch (IOException e) { logger.error("Unable to determine container's URL! Skipping registration.", e); return; } if (this.baseURL != null) { // we've tried to register before (or we are being // forced to // retry) // do a string comparison as we don't want to do DNS // lookups // for comparison if (forceRefresh || !this.baseURL.equals(currentContainerURL)) { // we've tried to register before, and we have a // different // URL now.. so cancel the old registration (if // it // exists), // and try to redo it. if (registrationClient != null) { try { this.registrationClient.unregister(); } catch (UnregistrationException e) { logger.error( "Problem unregistering existing registration:" + e.getMessage(), e); } } // save the new value this.baseURL = currentContainerURL; logger.info( "Refreshing existing registration [container URL=" + this.baseURL + "]."); } else { // URLs are the same (and we weren't forced), so // don't // try // to reregister return; } } else { // we've never saved the baseURL (and therefore // haven't // tried to // register) this.baseURL = currentContainerURL; logger.info("Attempting registration for the first time[container URL=" + this.baseURL + "]."); } try { // perform the registration for this service this.registrationClient = new AdvertisementClient(params); this.registrationClient.register(); } catch (Exception e) { logger.error("Exception when trying to register service (" + epr + "): " + e, e); } } else { logger.info("No resource properties to register for service (" + epr + ")"); } } else { logger.warn("Registration file deserialized with no poll type (" + epr + ")"); } } else { logger.warn("Registration file deserialized with returned null SeviceGroupParams"); } } else { logger.info("Skipping registration."); } } private void populateResourceProperties() { loadServiceMetadataFromFile(); loadDomainModelFromFile(); } private void loadServiceMetadataFromFile() { if (getServiceMetadata() == null) { try { File dataFile = new File(ContainerConfig.getBaseDirectory() + File.separator + getConfiguration().getServiceMetadataFile()); ((CaArraySvcResourceProperties) this.getResourceBean()) .setServiceMetadata((gov.nih.nci.cagrid.metadata.ServiceMetadata) Utils.deserializeDocument( dataFile.getAbsolutePath(), gov.nih.nci.cagrid.metadata.ServiceMetadata.class)); } catch (Exception e) { logger.error("ERROR: problem populating metadata from file: " + e.getMessage(), e); } } } private void loadDomainModelFromFile() { if (getDomainModel() == null) { try { File dataFile = new File(ContainerConfig.getBaseDirectory() + File.separator + getConfiguration().getDomainModelFile()); ((CaArraySvcResourceProperties) this.getResourceBean()) .setDomainModel((gov.nih.nci.cagrid.metadata.dataservice.DomainModel) Utils .deserializeDocument(dataFile.getAbsolutePath(), gov.nih.nci.cagrid.metadata.dataservice.DomainModel.class)); } catch (Exception e) { logger.error("ERROR: problem populating metadata from file: " + e.getMessage(), e); } } } }