RegistryAccessObject


1   /*
2    * The contents of this file are subject to the terms 
3    * of the Common Development and Distribution License 
4    * (the License).  You may not use this file except in
5    * compliance with the License.
6    * 
7    * You can obtain a copy of the license at 
8    * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9    * glassfish/bootstrap/legal/CDDLv1.0.txt.
10   * See the License for the specific language governing 
11   * permissions and limitations under the License.
12   * 
13   * When distributing Covered Code, include this CDDL 
14   * Header Notice in each file and include the License file 
15   * at glassfish/bootstrap/legal/CDDLv1.0.txt.  
16   * If applicable, add the following below the CDDL Header, 
17   * with the fields enclosed by brackets [] replaced by
18   * you own identifying information: 
19   * "Portions Copyrighted [year] [name of copyright owner]"
20   * 
21   * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22   */
23  
24  package com.sun.enterprise.admin.wsmgmt.registry;
25  
26  /**
27   ** RegistryAccessObject is based on DataAccessObject pattern. It facilitates
28   * access to the registry operations. A new RegistryAccessObject is created
29   * for each publishToRegistry, unpublishFromRegistry and listRegistryLocations
30   * operation from asadmin.
31   * 
32   * A RAO encapsulates connection objects to each of the listed registry locations
33   * specificed by registryJndiNames
34   *
35   * @author Harpreet Singh
36   */
37  public interface RegistryAccessObject {
38       
39       /**
40       * publish a web service to a set of registries
41       * @param String[] list of registry-locations specified by the jndi name 
42       * of the connector-connection-pool. The list of names can be obtained by 
43       * using the listRegistryLocations method
44       * @param String web service name 
45       * @param String load balancer host where this webservice is (optionally)
46       * hosted. A null string signifies that the host is optional and is to be 
47       * ignored while publishing this web service
48       * @param int load balancer port where this webservice is (optionally) 
49       * hosted. A value of -1 indicates that this is optional and is to be 
50       * ignored
51       * @param int load balancer ssl port where this webservice is (optionally) 
52       * hosted. A value of -1 indicates that this is optional and is to be 
53       * ignored
54       * @param String[] an (optional) list of categories that can qualify this 
55       * webservice. A null value indicates that this optional and is to be 
56       * ignored
57       * @param String description an (optional) description. A null value 
58       * indicates that this is to be ignored
59       * @return boolean true if published, false otherwise.
60       */
61      public boolean publish(String  [] registryLocations, String   webServiceName, 
62              String   lbhost, int lbport, int lbsslport, String  [] categories, String   organization, 
63              String   description);
64      
65      /**
66       * Unpublishes a web service wsdl from a list of registries
67       * @param String[] list of registry-locations
68       * @param String web service name whose wsdl needs to be unpublised
69       * @return boolean true if unpublished successfully
70       */   
71      public boolean unpublishFromRegistry(String  [] registryJndiNames, 
72             String   webServiceName);
73         
74      /**
75       * List the RegistryLocations. A registry location is the jndi name of a
76       * connection pool that points to a registry determined by the
77       * connector connection definition of the type JAXR_REGISTRY_TYPE
78       * @return String[] list of registry-location
79       */
80      public String  [] listRegistryLocations ();
81      
82  }
83
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags