KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > appserv > management > ext > wsmgmt > MessageTrace


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 package com.sun.appserv.management.ext.wsmgmt;
24
25 import com.sun.appserv.management.base.MapCapable;
26
27 /**
28  * Provides details of a SOAP invocation.
29  *
30  * @since AppServer 9.0
31  */
32 public interface MessageTrace extends MapCapable
33  {
34
35     /** This interface's class name */
36     public final static String JavaDoc CLASS_NAME =
37                 "com.sun.appserv.management.ext.wsmgmt.MessageTrace";
38
39     /**
40      * Returns the total size in bytes of the request content. This is
41      * SOAP content size including body and headers.
42      *
43      * @return SOAP request content size in bytes
44      */
45     public int getRequestSize();
46
47     /**
48      * Returns the total size in bytes of the response content. This is
49      * SOAP content size including body and headers.
50      *
51      * @return SOAP response content size in bytes
52      */
53     public int getResponseSize();
54
55     /**
56      * Returns the SOAP request content. This contains SOAP body and headers.
57      *
58      * @return SOAP request content
59      */
60     public String JavaDoc getRequestContent();
61
62     /**
63      * Returns the SOAP response content. This contains SOAP body and headers.
64      *
65      * @return SOAP response content
66      */
67     public String JavaDoc getResponseContent();
68
69     /**
70      * Returns the transport type. Known types are "HTTP", "JMS" and "SNMP".
71      *
72      * @return transport type
73      */
74     public String JavaDoc getTransportType();
75
76     /**
77      * Returns the comma separated list of HTTP request header names and its
78      * values. Null if transport type is not HTTP.
79      *
80      * @return HTTP request headers
81      */
82     public String JavaDoc getHTTPRequestHeaders();
83
84     /**
85      * Returns the comma separated list of HTTP response header names and its
86      * values. Null if transport type is not HTTP.
87      *
88      * @return HTTP response headers
89      */
90     public String JavaDoc getHTTPResponseHeaders();
91
92     /**
93      * Returns the IP address or host name of the client machine.
94      *
95      * @return IP address or host name of client
96      */
97     public String JavaDoc getClientHost();
98
99     /**
100      * Returns the caller principal name.
101      *
102      * @return caller principal name
103      */
104     public String JavaDoc getPrincipalName();
105
106     /**
107      * Returns the response time in milli seconds for this web service
108      * operation.
109      *
110      * @return reponse time in milli seconds
111      */
112     public long getResponseTime();
113
114     /**
115      * Returns the fault code.
116      *
117      * @return fault code for this web service or null
118      */
119     public String JavaDoc getFaultCode();
120
121     /**
122      * Returns the fault string.
123      *
124      * @return fault string for this web service or null
125      */
126     public String JavaDoc getFaultString();
127
128     /**
129      * Returns the fault actor.
130      *
131      * @return fault actor for this web service
132      */
133     public String JavaDoc getFaultActor();
134
135     /**
136      * Returns the message id.
137      *
138      * @return message id
139      */
140     public String JavaDoc getMessageID();
141
142     /**
143      * Returns the name of the application.
144      *
145      * @return application name
146      */
147     public String JavaDoc getApplicationID();
148
149     /**
150      * Returns the name of the webservice endpoint.
151      *
152      * @return name of the webservice endpoint
153      */
154     public String JavaDoc getEndpointName();
155
156     /**
157      * Returns the time stamp when the SOAP message was received.
158      *
159      * @return the time stamp when the SOAP message was received
160      */
161     public long getTimestamp();
162
163     /**
164      * Returns if during this web service invocation call flow was enabled or
165      * not
166      *
167      * @return true, if during this web service invocation call flow was
168      * enabled otherwise flase.
169      */
170     public boolean isCallFlowEnabled();
171 }
172
Popular Tags