001: /*
002: * The Apache Software License, Version 1.1
003: *
004: *
005: * Copyright (c) 2002 The Apache Software Foundation. All rights
006: * reserved.
007: *
008: * Redistribution and use in source and binary forms, with or without
009: * modification, are permitted provided that the following conditions
010: * are met:
011: *
012: * 1. Redistributions of source code must retain the above copyright
013: * notice, this list of conditions and the following disclaimer.
014: *
015: * 2. Redistributions in binary form must reproduce the above copyright
016: * notice, this list of conditions and the following disclaimer in
017: * the documentation and/or other materials provided with the
018: * distribution.
019: *
020: * 3. The end-user documentation included with the redistribution,
021: * if any, must include the following acknowledgment:
022: * "This product includes software developed by the
023: * Apache Software Foundation (http://www.apache.org/)."
024: * Alternately, this acknowledgment may appear in the software itself,
025: * if and wherever such third-party acknowledgments normally appear.
026: *
027: * 4. The names "WSIF" and "Apache Software Foundation" must
028: * not be used to endorse or promote products derived from this
029: * software without prior written permission. For written
030: * permission, please contact apache@apache.org.
031: *
032: * 5. Products derived from this software may not be called "Apache",
033: * nor may "Apache" appear in their name, without prior written
034: * permission of the Apache Software Foundation.
035: *
036: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
037: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
038: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
039: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
040: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
041: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
042: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
043: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
044: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
045: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
046: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
047: * SUCH DAMAGE.
048: * ====================================================================
049: *
050: * This software consists of voluntary contributions made by many
051: * individuals on behalf of the Apache Software Foundation and was
052: * originally based on software copyright (c) 2001, 2002, International
053: * Business Machines, Inc., http://www.apache.org. For more
054: * information on the Apache Software Foundation, please see
055: * <http://www.apache.org/>.
056: */
057:
058: package org.apache.wsif.util.jms;
059:
060: import org.apache.wsif.WSIFCorrelationId;
061:
062: /**
063: * A WSIFCorrelationId is used to identify asynchronous
064: * requests so that a request can be matched to its response.
065: *
066: * @author Ant Elder <ant.elder@uk.ibm.com>
067: */
068: public class WSIFJMSCorrelationId implements WSIFCorrelationId {
069: private static final long serialVersionUID = 1L;
070:
071: private String id;
072:
073: /**
074: * Creates a new WSIFJMSCorrelationId.
075: *
076: * @param id the id string
077: */
078: public WSIFJMSCorrelationId(String id) {
079: if (id.length() < 256) {
080: this .id = id;
081: } else {
082: throw new IllegalArgumentException(
083: "id length must be less than 256 characters");
084: }
085: }
086:
087: /**
088: * gets the value of this WSIFJMSCorrelationId as a String.
089: *
090: * @param the String value of this id
091: */
092: public String getCorrelationId() {
093: return id;
094: }
095:
096: /**
097: * gets the value of this WSIFJMSCorrelationId as a byte array.
098: *
099: * @param a byte array of this id
100: */
101: public byte[] getCorrelationIdAsBytes() {
102: return id.getBytes();
103: }
104:
105: /**
106: * Compares this WSIFJMSCorrelationId to the specified object.
107: * The result is true if and only if the argument is not null
108: * and is a WSIFCorrelationId object that represents the same
109: * String id as this object.
110: *
111: * @return true if the WSIFCorrelationId's have the same id,
112: * otherwise false;
113: */
114: public boolean equals(Object cid) {
115: if (cid != null && cid instanceof WSIFCorrelationId) {
116: return this .id.equals(((WSIFCorrelationId) cid)
117: .getCorrelationId());
118: } else {
119: return false;
120: }
121: }
122:
123: /**
124: * The String representation of this object is returned.
125: *
126: * @return the id string.
127: */
128: public String toString() {
129: return id;
130: }
131:
132: /**
133: * Returns a hashcode for this object.
134: *
135: * @return a hash code value for this object.
136: */
137: public int hashCode() {
138: return id.hashCode();
139: }
140: }
|