KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > enterprise > webservice > monitoring > WebServiceEngine


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  * WebServiceEngine.java
26  *
27  * Created on March 10, 2005, 3:36 PM
28  */
29
30 package com.sun.enterprise.webservice.monitoring;
31
32 import java.util.Iterator JavaDoc;
33
34 /**
35  * This interface holds all behaviour associated with the
36  * web service engine. For instance, it gives a list of all
37  * registered endoints, provide hooks to register listener
38  * interfaces for endpoints creation/deletion and so on...
39  *
40  * @author Jerome Dochez
41  */
42 public interface WebServiceEngine {
43     
44     /**
45      * @return an iterator of all the registered active endpoints in
46      * the engine.
47      */
48     public Iterator JavaDoc<Endpoint> getEndpoints();
49     
50     /**
51      * @return an Endpoint instance if the supplied selector is the endpoint's
52      * invocation selector. In case of HTTP based web services, the selector is
53      * the endpoint URL
54      * @param endpointSelector the endpoint selector
55      */
56     public Endpoint getEndpoint(String JavaDoc endpointSelector);
57     
58     /**
59      * Register a new listener interface to receive notification of
60      * web service endpoint creation and deletion
61      * @param listener instance to register
62      */
63     public void addLifecycleListener(EndpointLifecycleListener listener);
64     
65     /**
66      * Unregister a listener interface
67      * @param listener to unregister.
68      */
69     public void removeLifecycleListener(EndpointLifecycleListener listener);
70     
71     /**
72      * Register a new listener interface to receive authentication
73      * notification.
74      * @param listener to add
75      */
76     public void addAuthListener(AuthenticationListener listener);
77     
78     /**
79      * Unregister a listener interface
80      * @param listener to remove
81      */
82     public void removeAuthListener(AuthenticationListener listener);
83     
84     /**
85      * Set the unique global listener interface to trace all web service requests
86      * or responses. Set to null if no tracing is needed
87      * @param listener to register
88      */
89     public void setGlobalMessageListener(GlobalMessageListener listener);
90     
91     /**
92      * get the global listener interface or null if none is set.
93      * @return the global message listener
94      */
95     public GlobalMessageListener getGlobalMessageListener();
96     
97 }
98
Popular Tags