KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > wsif > util > jms > WSIFJMSCorrelationId


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2002 The Apache Software Foundation. All rights
6  * reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Apache Software Foundation (http://www.apache.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "WSIF" and "Apache Software Foundation" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation and was
52  * originally based on software copyright (c) 2001, 2002, International
53  * Business Machines, Inc., http://www.apache.org. For more
54  * information on the Apache Software Foundation, please see
55  * <http://www.apache.org/>.
56  */
57
58 package org.apache.wsif.util.jms;
59
60 import org.apache.wsif.WSIFCorrelationId;
61
62 /**
63  * A WSIFCorrelationId is used to identify asynchronous
64  * requests so that a request can be matched to its response.
65  *
66  * @author Ant Elder <ant.elder@uk.ibm.com>
67  */
68 public class WSIFJMSCorrelationId implements WSIFCorrelationId {
69     private static final long serialVersionUID = 1L;
70
71     private String JavaDoc id;
72
73     /**
74      * Creates a new WSIFJMSCorrelationId.
75      *
76      * @param id the id string
77      */
78     public WSIFJMSCorrelationId(String JavaDoc id) {
79         if (id.length() < 256) {
80             this.id = id;
81         } else {
82             throw new IllegalArgumentException JavaDoc("id length must be less than 256 characters");
83         }
84     }
85
86     /**
87      * gets the value of this WSIFJMSCorrelationId as a String.
88      *
89      * @param the String value of this id
90      */
91     public String JavaDoc getCorrelationId() {
92         return id;
93     }
94
95     /**
96      * gets the value of this WSIFJMSCorrelationId as a byte array.
97      *
98      * @param a byte array of this id
99      */
100     public byte[] getCorrelationIdAsBytes() {
101         return id.getBytes();
102     }
103
104     /**
105      * Compares this WSIFJMSCorrelationId to the specified object.
106      * The result is true if and only if the argument is not null
107      * and is a WSIFCorrelationId object that represents the same
108      * String id as this object.
109      *
110      * @return true if the WSIFCorrelationId's have the same id,
111      * otherwise false;
112      */
113     public boolean equals(Object JavaDoc cid) {
114         if (cid != null && cid instanceof WSIFCorrelationId) {
115             return this.id.equals(((WSIFCorrelationId) cid).getCorrelationId());
116         } else {
117             return false;
118         }
119     }
120
121     /**
122      * The String representation of this object is returned.
123      *
124      * @return the id string.
125      */
126     public String JavaDoc toString() {
127         return id;
128     }
129
130     /**
131      * Returns a hashcode for this object.
132      *
133      * @return a hash code value for this object.
134      */
135     public int hashCode() {
136         return id.hashCode();
137     }
138 }
Popular Tags