WebServiceEndpointConfig


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  
25  package com.sun.appserv.management.config;
26  
27  import java.util.Map  ;
28  import java.util.List  ;
29  
30  import com.sun.appserv.management.base.XTypes;
31  import com.sun.appserv.management.base.Container;
32  
33  /**
34   * Config AMX MBean for Web Service Endpoint's config
35   * 
36   * @since AppServer 9.0
37   */
38  public interface WebServiceEndpointConfig extends NamedConfigElement, Container
39  {
40      public static final String    J2EE_TYPE   = XTypes.WEB_SERVICE_ENDPOINT_CONFIG;
41  
42      /**
43      * Get the web service name.
44      */
45      public String   getName();
46  
47      /**
48      * visibility of this endoint as a service in JBI
49      */
50      public boolean getJBIEnabled();
51  
52      /**
53      * visibility of this endoint as a service in JBI
54      */
55      public void setJBIEnabled( boolean enabled );
56  
57      /**
58      * Get the web service' monitoring level can be OFF, LOW or HIGH.
59      @see ModuleMonitoringLevelValues
60      */
61      public String   getMonitoringLevel();
62  
63      /**
64      * Sets the web service' monitoring level can be OFF, LOW or HIGH.
65      @see ModuleMonitoringLevelValues
66      */
67      public void setMonitoringLevel( String   level );
68  
69      /**
70      * Gets the web service' max history size. Number of statistics stored in
71      * memory.
72      */
73      public String   getMaxHistorySize();
74  
75      /**
76      * Sets the web service' max history size. Number of statistics stored in
77      * memory.
78      *
79      * @param maxSize max size of stored statistics in memory
80      */
81      public void setMaxHistorySize(String   maxSize);
82      
83      /**
84          @since Appserver 9.0
85       */
86      public Map  <String  ,RegistryLocationConfig> getRegistryLocationConfigMap();
87      
88      
89      /**
90          @since Appserver 9.0
91       */
92      public RegistryLocationConfig createRegistryLocationConfig( String   jndiName );
93      
94      /**
95          @since Appserver 9.0
96       */
97      public void removeRegistryLocationConfig( String   jndiName );
98      
99  
100     /**
101     * Get the transformation rules (not in any specific order) defined for this
102     * end point.
103     *
104     * @return Map of transformation rules added to web service.
105     */
106     public Map  <String  ,TransformationRuleConfig> getTransformationRuleConfigMap();
107     /**
108     * Get the transformation rules (in the same order as in domain.xml) 
109     * defined for this end point.
110     *
111     * @return Map of transformation rules added to web service.
112     */
113     public List  <TransformationRuleConfig> getTransformationRuleConfigList();
114 
115 
116     /**
117     * Removes the specified transformation rule for this end point.
118     *
119     * @param name Name of the transformation rule
120     */
121     public void removeTransformationRuleConfig(String   name);
122 
123     /**
124     * Creates a transformation rule for this web service.
125     *
126     * @param name  this transformation rule's name
127     * @param ruleFileLocation File path location of this transformation rule
128     * @param applyTo Operation(s) for which this
129     * transformation rule is applied. Possible values are "request", "response"
130     * or "both"
131     * @param enabled If true transformation rule is applied
132     *
133     * @return TransformationRule new transformation rule with the
134     * specified parameters
135     */
136     public TransformationRuleConfig createTransformationRuleConfig(
137          String   name,  String   ruleFileLocation,boolean enabled, String   applyTo,
138          Map  <String  ,String  > reserved);
139 }
140
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags