org.apache.catalina.deploy.ContextResource Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.catalina.deploy;
/**
* Representation of a resource reference for a web application, as
* represented in a <resource-ref> element in the
* deployment descriptor.
*
* @author Craig R. McClanahan
* @author Peter Rossbach ([email protected])
* @version $Id: ContextResource.java 1087286 2011-03-31 13:02:20Z markt $
*/
public class ContextResource extends ResourceBase {
private static final long serialVersionUID = 1L;
// ------------------------------------------------------------- Properties
/**
* The authorization requirement for this resource
* (Application or Container).
*/
private String auth = null;
public String getAuth() {
return (this.auth);
}
public void setAuth(String auth) {
this.auth = auth;
}
/**
* The sharing scope of this resource factory (Shareable
* or Unshareable).
*/
private String scope = "Shareable";
public String getScope() {
return (this.scope);
}
public void setScope(String scope) {
this.scope = scope;
}
/**
* Is this resource known to be a singleton resource. The default value is
* true since this is what users expect although the JavaEE spec implies
* that the default should be false.
*/
private boolean singleton = true;
public boolean getSingleton() {
return singleton;
}
public void setSingleton(boolean singleton) {
this.singleton = singleton;
}
/**
* The name of the zero argument method to be called when the resource is
* no longer required to clean-up resources. This method must only speed up
* the clean-up of resources that would otherwise happen via garbage
* collection.
*/
private String closeMethod = null;
public String getCloseMethod() {
return closeMethod;
}
public void setCloseMethod(String closeMethod) {
this.closeMethod = closeMethod;
}
// --------------------------------------------------------- Public Methods
/**
* Return a String representation of this object.
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder("ContextResource[");
sb.append("name=");
sb.append(getName());
if (getDescription() != null) {
sb.append(", description=");
sb.append(getDescription());
}
if (getType() != null) {
sb.append(", type=");
sb.append(getType());
}
if (auth != null) {
sb.append(", auth=");
sb.append(auth);
}
if (scope != null) {
sb.append(", scope=");
sb.append(scope);
}
sb.append("]");
return (sb.toString());
}
}