org.glassfish.deployment.common.DynamicAttributesDescriptor Maven / Gradle / Ivy
The newest version!
/*
* Copyright (c) 2022 Contributors to the Eclipse Foundation
* Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package org.glassfish.deployment.common;
import java.io.Serializable;
import java.util.Hashtable;
import java.util.Map;
import java.util.Observable;
import java.util.Set;
/**
* This class is a value holder for dynamic attributes. Dynamic attributes
* can be added, queried and removed from this value holder. Attributes are
* identified by a string key.
*
* @author Jerome Dochez
*/
public class DynamicAttributesDescriptor extends Observable implements Serializable {
private Map dynamicAttributes;
/**
* Direct acess to the dynamic attributes repository
* @return the Map of dynamic attributes
*/
public Map getExtraAttributes() {
if (dynamicAttributes == null) {
dynamicAttributes = new Hashtable<>();
}
return dynamicAttributes;
}
/**
* Add a new dynamic attribte
* @param name the attribute name
* @param value the attribute value
*/
public void addExtraAttribute(String name, Object value) {
if (value == null) {
return;
}
if (dynamicAttributes == null) {
dynamicAttributes = new Hashtable<>();
}
dynamicAttributes.put(name, value);
changed();
}
/**
* Obtain a dynamic attribute from the repository
* @param name the attribute name
* @return the attribute value of null of non existent
*/
public T getExtraAttribute(String name) {
if (dynamicAttributes == null) {
return null;
}
return (T) dynamicAttributes.get(name);
}
/**
* Removes a dynamic attribute from the repository
* @param name the attribute name
*/
public void removeExtraAttribute(String name) {
if (dynamicAttributes == null) {
return;
}
dynamicAttributes.remove(name);
changed();
}
/**
* @return a meaningfull string about ourself
* This method is invoked by toString() method. This method can be overwritten by any descriptor which inherits this class
* to self describe. This pattern is adopted to imporve the performance of S1AS 8.0 which avoids creation of several String objects
* in toString() method.
* When toString() method is called on a Descriptor object, the toString method of this class is called.
* The toString method of this class invokes print(StringBuffer) method. If the Descriptor object overrides print method, its method
* will be invoked.
* For better performance, care should be taken to use print method on all descriptors instead of printing object itself (which calls to toString).
* For example
* Iterator itr = getDeploymentExtensions();
if (itr!=null && itr.hasNext()) {
do {
sb.append("\n Deployment Extension : ").append(itr.next());
} while (itr.hasNext());
}
should probably read as below.
Iterator itr = getDeploymentExtensions();
if (itr!=null && itr.hasNext()) {
do {
sb.append("\n Deployment Extension : ");
((Descriptor) itr.next()).print(sb);
} while (itr.hasNext());
}
*/
public void print(StringBuffer toStringBuffer) {
if (dynamicAttributes == null) {
toStringBuffer.append("<== No attribute ==>");
} else {
toStringBuffer.append("==>Dynamic Attribute");
Set keys = dynamicAttributes.keySet();
for (Object key : keys) {
String keyName = (String) key;
Object o = getExtraAttribute(keyName);
if (o instanceof Object[]) {
Object[] objects = (Object[]) o;
for (int i = 0; i < objects.length; i++) {
toStringBuffer.append("\n Indexed prop name ").append(keyName).append("[").append(i)
.append("] = ");
if (objects[i] instanceof DynamicAttributesDescriptor) {
((DynamicAttributesDescriptor) objects[i]).print(toStringBuffer);
} else {
toStringBuffer.append(objects[i]);
}
}
} else {
toStringBuffer.append("\n Property name = ").append(keyName).append(" value = ");
if (o instanceof DynamicAttributesDescriptor) {
((DynamicAttributesDescriptor) o).print(toStringBuffer);
} else {
toStringBuffer.append(o);
}
}
}
toStringBuffer.append("\n<==End");
return;
}
}
/**
* Provides a meaningfull string about ourself.
*
* No Descriptor class which inherits this class should override this method.
* Rather print() method which is defined in this class should be overridden to describe itself.
* Refer to the comments on print() method for more details.
*
* This method is optimized for persformance reasons.
*/
@Override
public String toString() {
StringBuffer toStringBuf = new StringBuffer();
this.print(toStringBuf);
return toStringBuf.toString();
}
/**
* notify our observers we have changed
*/
private void changed() {
setChanged();
notifyObservers();
}
}