001: /*
002: * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/naming/ResourceRef.java,v 1.2 2001/11/10 00:01:55 craigmcc Exp $
003: * $Revision: 1.2 $
004: * $Date: 2001/11/10 00:01:55 $
005: *
006: * ====================================================================
007: *
008: * The Apache Software License, Version 1.1
009: *
010: * Copyright (c) 1999 The Apache Software Foundation. All rights
011: * reserved.
012: *
013: * Redistribution and use in source and binary forms, with or without
014: * modification, are permitted provided that the following conditions
015: * are met:
016: *
017: * 1. Redistributions of source code must retain the above copyright
018: * notice, this list of conditions and the following disclaimer.
019: *
020: * 2. Redistributions in binary form must reproduce the above copyright
021: * notice, this list of conditions and the following disclaimer in
022: * the documentation and/or other materials provided with the
023: * distribution.
024: *
025: * 3. The end-user documentation included with the redistribution, if
026: * any, must include the following acknowlegement:
027: * "This product includes software developed by the
028: * Apache Software Foundation (http://www.apache.org/)."
029: * Alternately, this acknowlegement may appear in the software itself,
030: * if and wherever such third-party acknowlegements normally appear.
031: *
032: * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
033: * Foundation" must not be used to endorse or promote products derived
034: * from this software without prior written permission. For written
035: * permission, please contact apache@apache.org.
036: *
037: * 5. Products derived from this software may not be called "Apache"
038: * nor may "Apache" appear in their names without prior written
039: * permission of the Apache Group.
040: *
041: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
042: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
043: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
044: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
045: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
046: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
047: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
048: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
049: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
050: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
051: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
052: * SUCH DAMAGE.
053: * ====================================================================
054: *
055: * This software consists of voluntary contributions made by many
056: * individuals on behalf of the Apache Software Foundation. For more
057: * information on the Apache Software Foundation, please see
058: * <http://www.apache.org/>.
059: *
060: * [Additional notices, if required by prior licensing conditions]
061: *
062: */
063:
064: package org.apache.naming;
065:
066: import java.util.Enumeration;
067: import java.util.Hashtable;
068: import javax.naming.RefAddr;
069: import javax.naming.Reference;
070: import javax.naming.Context;
071: import javax.naming.StringRefAddr;
072:
073: /**
074: * Represents a reference address to a resource.
075: *
076: * @author Remy Maucherat
077: * @version $Revision: 1.2 $ $Date: 2001/11/10 00:01:55 $
078: */
079:
080: public class ResourceRef extends Reference {
081:
082: // -------------------------------------------------------------- Constants
083:
084: /**
085: * Default factory for this reference.
086: */
087: public static final String DEFAULT_FACTORY = org.apache.naming.factory.Constants.DEFAULT_RESOURCE_FACTORY;
088:
089: /**
090: * Description address type.
091: */
092: public static final String DESCRIPTION = "description";
093:
094: /**
095: * Scope address type.
096: */
097: public static final String SCOPE = "scope";
098:
099: /**
100: * Auth address type.
101: */
102: public static final String AUTH = "auth";
103:
104: // ----------------------------------------------------------- Constructors
105:
106: /**
107: * Resource Reference.
108: *
109: * @param resourceClass Resource class
110: * @param scope Resource scope
111: * @param auth Resource authetication
112: */
113: public ResourceRef(String resourceClass, String description,
114: String scope, String auth) {
115: this (resourceClass, description, scope, auth, null, null);
116: }
117:
118: /**
119: * Resource Reference.
120: *
121: * @param resourceClass Resource class
122: * @param scope Resource scope
123: * @param auth Resource authetication
124: */
125: public ResourceRef(String resourceClass, String description,
126: String scope, String auth, String factory,
127: String factoryLocation) {
128: super (resourceClass, factory, factoryLocation);
129: StringRefAddr refAddr = null;
130: if (description != null) {
131: refAddr = new StringRefAddr(DESCRIPTION, description);
132: add(refAddr);
133: }
134: if (scope != null) {
135: refAddr = new StringRefAddr(SCOPE, scope);
136: add(refAddr);
137: }
138: if (auth != null) {
139: refAddr = new StringRefAddr(AUTH, auth);
140: add(refAddr);
141: }
142: }
143:
144: // ----------------------------------------------------- Instance Variables
145:
146: // ------------------------------------------------------ Reference Methods
147:
148: /**
149: * Retrieves the class name of the factory of the object to which this
150: * reference refers.
151: */
152: public String getFactoryClassName() {
153: String factory = super .getFactoryClassName();
154: if (factory != null) {
155: return factory;
156: } else {
157: factory = System.getProperty(Context.OBJECT_FACTORIES);
158: if (factory != null) {
159: return null;
160: } else {
161: return DEFAULT_FACTORY;
162: }
163: }
164: }
165:
166: // --------------------------------------------------------- Public Methods
167:
168: /**
169: * Return a String rendering of this object.
170: */
171: public String toString() {
172:
173: StringBuffer sb = new StringBuffer("ResourceRef[");
174: sb.append("className=");
175: sb.append(getClassName());
176: sb.append(",factoryClassLocation=");
177: sb.append(getFactoryClassLocation());
178: sb.append(",factoryClassName=");
179: sb.append(getFactoryClassName());
180: Enumeration refAddrs = getAll();
181: while (refAddrs.hasMoreElements()) {
182: RefAddr refAddr = (RefAddr) refAddrs.nextElement();
183: sb.append(",{type=");
184: sb.append(refAddr.getType());
185: sb.append(",content=");
186: sb.append(refAddr.getContent());
187: sb.append("}");
188: }
189: sb.append("]");
190: return (sb.toString());
191:
192: }
193:
194: // ------------------------------------------------------------- Properties
195:
196: }
|