http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8bf39571/geode-core/src/main/java/org/apache/geode/admin/internal/SystemMemberRegionEventImpl.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/org/apache/geode/admin/internal/SystemMemberRegionEventImpl.java b/geode-core/src/main/java/org/apache/geode/admin/internal/SystemMemberRegionEventImpl.java index c59e049..74115bb 100644 --- a/geode-core/src/main/java/org/apache/geode/admin/internal/SystemMemberRegionEventImpl.java +++ b/geode-core/src/main/java/org/apache/geode/admin/internal/SystemMemberRegionEventImpl.java @@ -1,18 +1,16 @@ /* - * 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 + * 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 + * 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. + * 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.geode.admin.internal; @@ -21,34 +19,30 @@ import org.apache.geode.distributed.DistributedMember; import org.apache.geode.cache.Operation; /** - * An event that describes an operation on a region. - * Instances of this are delivered to a {@link SystemMemberCacheListener} when a - * a region comes or goes. + * An event that describes an operation on a region. Instances of this are delivered to a + * {@link SystemMemberCacheListener} when a a region comes or goes. * * @since GemFire 5.0 */ -public class SystemMemberRegionEventImpl - extends SystemMemberCacheEventImpl - implements SystemMemberRegionEvent -{ +public class SystemMemberRegionEventImpl extends SystemMemberCacheEventImpl + implements SystemMemberRegionEvent { - /** - * The path of region created/destroyed + /** + * The path of region created/destroyed */ private final String regionPath; - /////////////////////// Constructors /////////////////////// + /////////////////////// Constructors /////////////////////// /** - * Creates a new <code>SystemMemberRegionEvent</code> for the member - * with the given id. + * Creates a new <code>SystemMemberRegionEvent</code> for the member with the given id. */ protected SystemMemberRegionEventImpl(DistributedMember id, Operation op, String regionPath) { super(id, op); this.regionPath = regionPath; } - ///////////////////// Instance Methods ///////////////////// + ///////////////////// Instance Methods ///////////////////// public String getRegionPath() { return this.regionPath;
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8bf39571/geode-core/src/main/java/org/apache/geode/admin/internal/SystemMemberRegionImpl.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/org/apache/geode/admin/internal/SystemMemberRegionImpl.java b/geode-core/src/main/java/org/apache/geode/admin/internal/SystemMemberRegionImpl.java index 9e8f392..fbf0839 100644 --- a/geode-core/src/main/java/org/apache/geode/admin/internal/SystemMemberRegionImpl.java +++ b/geode-core/src/main/java/org/apache/geode/admin/internal/SystemMemberRegionImpl.java @@ -1,25 +1,23 @@ /* - * 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 + * 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 + * 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. + * 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.geode.admin.internal; import org.apache.geode.admin.*; import org.apache.geode.cache.*; -//import org.apache.geode.internal.Assert; -//import org.apache.geode.internal.admin.*; +// import org.apache.geode.internal.Assert; +// import org.apache.geode.internal.admin.*; import org.apache.geode.internal.admin.remote.*; import java.io.File; @@ -28,7 +26,7 @@ import java.util.*; /** * View of a region in a GemFire system member's cache. * - * @since GemFire 3.5 + * @since GemFire 3.5 */ public class SystemMemberRegionImpl implements SystemMemberRegion { @@ -44,10 +42,9 @@ public class SystemMemberRegionImpl implements SystemMemberRegion { private final SystemMemberCacheImpl cache; // constructors - public SystemMemberRegionImpl(SystemMemberCacheImpl cache, Region r) - { + public SystemMemberRegionImpl(SystemMemberCacheImpl cache, Region r) { this.cache = cache; - this.r = (AdminRegion)r; + this.r = (AdminRegion) r; } private void refreshFields() { @@ -63,7 +60,7 @@ public class SystemMemberRegionImpl implements SystemMemberRegion { Set paths = new TreeSet(); Iterator it = s.iterator(); while (it.hasNext()) { - Region r = (Region)it.next(); + Region r = (Region) it.next(); String name = r.getName(); names.add(name); paths.add(this.getFullPath() + Region.SEPARATOR_CHAR + name); @@ -80,12 +77,12 @@ public class SystemMemberRegionImpl implements SystemMemberRegion { this.subregionCount = 0; } } - + // attributes public String getName() { return this.r.getName(); } - + public String getFullPath() { return this.r.getFullPath(); } @@ -99,7 +96,7 @@ public class SystemMemberRegionImpl implements SystemMemberRegion { } public String getUserAttribute() { - return (String)r.getUserAttribute(); + return (String) r.getUserAttribute(); } public String getCacheLoader() { @@ -110,6 +107,7 @@ public class SystemMemberRegionImpl implements SystemMemberRegion { return o.toString(); } } + public String getCacheWriter() { Object o = this.ra.getCacheWriter(); if (o == null) { @@ -165,7 +163,7 @@ public class SystemMemberRegionImpl implements SystemMemberRegion { return o.toString(); } } - + public int getRegionIdleTimeoutTimeLimit() { return this.ra.getRegionIdleTimeout().getTimeout(); } @@ -190,15 +188,15 @@ public class SystemMemberRegionImpl implements SystemMemberRegion { return o.toString(); } } - + public MirrorType getMirrorType() { return this.ra.getMirrorType(); } - + public DataPolicy getDataPolicy() { return this.ra.getDataPolicy(); } - + public Scope getScope() { return this.ra.getScope(); } @@ -208,10 +206,9 @@ public class SystemMemberRegionImpl implements SystemMemberRegion { } /** - * This method will return an empty string if there are no CacheListeners - * defined on the region. If there are more than 1 CacheListeners defined, - * this method will return the description of the 1st CacheListener in the - * list returned by the getCacheListeners method. If there is only one + * This method will return an empty string if there are no CacheListeners defined on the region. + * If there are more than 1 CacheListeners defined, this method will return the description of the + * 1st CacheListener in the list returned by the getCacheListeners method. If there is only one * CacheListener defined this method will return it's description * * @return String the region's <code>CacheListener</code> description @@ -222,20 +219,17 @@ public class SystemMemberRegionImpl implements SystemMemberRegion { String[] o = this.getCacheListeners(); if (o.length == 0) { return ""; - } - else { + } else { return o[0].toString(); } } /** - * This method will return an empty array if there are no CacheListeners - * defined on the region. If there are one or more than 1 CacheListeners - * defined, this method will return an array which has the description of all - * the CacheListeners + * This method will return an empty array if there are no CacheListeners defined on the region. If + * there are one or more than 1 CacheListeners defined, this method will return an array which has + * the description of all the CacheListeners * - * @return String[] the region's <code>CacheListeners</code> descriptions as a - * String array + * @return String[] the region's <code>CacheListeners</code> descriptions as a String array * @since GemFire 6.0 */ public String[] getCacheListeners() { @@ -243,8 +237,7 @@ public class SystemMemberRegionImpl implements SystemMemberRegion { String[] ret = null; if (o == null || o.length == 0) { ret = new String[0]; - } - else { + } else { ret = new String[o.length]; for (int i = 0; i < o.length; i++) { ret[i] = o[i].toString(); @@ -288,7 +281,7 @@ public class SystemMemberRegionImpl implements SystemMemberRegion { public int getEntryCount() { return this.entryCount; } - + public int getSubregionCount() { return this.subregionCount; } @@ -332,29 +325,27 @@ public class SystemMemberRegionImpl implements SystemMemberRegion { return this.rs.getHitRatio(); } } - + // operations public void refresh() { refreshFields(); } - /** - * Returns a string representation of the object. - * - * @return a string representation of the object - */ + /** + * Returns a string representation of the object. + * + * @return a string representation of the object + */ @Override - public String toString() { - return getName(); - } + public String toString() { + return getName(); + } - public SystemMemberRegion createSubregion(String name, - RegionAttributes attrs) - throws AdminException { + public SystemMemberRegion createSubregion(String name, RegionAttributes attrs) + throws AdminException { - Region r = - this.cache.getVM().createSubregion(this.cache.getCacheInfo(), - this.getFullPath(), name, attrs); + Region r = this.cache.getVM().createSubregion(this.cache.getCacheInfo(), this.getFullPath(), + name, attrs); if (r == null) { return null; @@ -367,11 +358,11 @@ public class SystemMemberRegionImpl implements SystemMemberRegion { public MembershipAttributes getMembershipAttributes() { return this.ra.getMembershipAttributes(); } - + public SubscriptionAttributes getSubscriptionAttributes() { return this.ra.getSubscriptionAttributes(); } - + public PartitionAttributes getPartitionAttributes() { return this.ra.getPartitionAttributes(); } http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8bf39571/geode-core/src/main/java/org/apache/geode/admin/internal/SystemMembershipEventImpl.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/org/apache/geode/admin/internal/SystemMembershipEventImpl.java b/geode-core/src/main/java/org/apache/geode/admin/internal/SystemMembershipEventImpl.java index 6ec9e94..ad5fd5a 100644 --- a/geode-core/src/main/java/org/apache/geode/admin/internal/SystemMembershipEventImpl.java +++ b/geode-core/src/main/java/org/apache/geode/admin/internal/SystemMembershipEventImpl.java @@ -1,18 +1,16 @@ /* - * 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 + * 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 + * 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. + * 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.geode.admin.internal; @@ -20,8 +18,8 @@ import org.apache.geode.admin.*; import org.apache.geode.distributed.DistributedMember; /** - * An event delivered to a {@link SystemMembershipListener} when a - * member has joined or left the distributed system. + * An event delivered to a {@link SystemMembershipListener} when a member has joined or left the + * distributed system. * * @since GemFire 5.0 */ @@ -30,37 +28,36 @@ public class SystemMembershipEventImpl implements SystemMembershipEvent { /** The id of the member that generated this event */ private DistributedMember id; - /////////////////////// Constructors /////////////////////// + /////////////////////// Constructors /////////////////////// /** - * Creates a new <code>SystemMembershipEvent</code> for the member - * with the given id. + * Creates a new <code>SystemMembershipEvent</code> for the member with the given id. */ protected SystemMembershipEventImpl(DistributedMember id) { this.id = id; } - ///////////////////// Instance Methods ///////////////////// + ///////////////////// Instance Methods ///////////////////// public String getMemberId() { return this.id.toString(); } - + public DistributedMember getDistributedMember() { return this.id; } -// /** -// * Returns the user specified callback object associated with this -// * membership event. Note that the callback argument is always -// * <code>null</code> for the event delivered to the {@link -// * SystemMembershipListener#memberCrashed} method. -// * -// * @since GemFire 4.0 -// */ -// public Object getCallbackArgument() { -// throw new UnsupportedOperationException("Not implemented yet"); -// } + // /** + // * Returns the user specified callback object associated with this + // * membership event. Note that the callback argument is always + // * <code>null</code> for the event delivered to the {@link + // * SystemMembershipListener#memberCrashed} method. + // * + // * @since GemFire 4.0 + // */ + // public Object getCallbackArgument() { + // throw new UnsupportedOperationException("Not implemented yet"); + // } @Override public String toString() { http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8bf39571/geode-core/src/main/java/org/apache/geode/admin/jmx/Agent.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/org/apache/geode/admin/jmx/Agent.java b/geode-core/src/main/java/org/apache/geode/admin/jmx/Agent.java index 9daa866..8e16dca 100644 --- a/geode-core/src/main/java/org/apache/geode/admin/jmx/Agent.java +++ b/geode-core/src/main/java/org/apache/geode/admin/jmx/Agent.java @@ -1,18 +1,16 @@ /* - * 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 + * 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 + * 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. + * 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.geode.admin.jmx; @@ -20,61 +18,56 @@ import org.apache.geode.LogWriter; import org.apache.geode.admin.AdminException; import org.apache.geode.admin.AdminDistributedSystem; -//import javax.management.MBeanException; +// import javax.management.MBeanException; import javax.management.MalformedObjectNameException; import javax.management.MBeanServer; import javax.management.ObjectName; /** - * A server component that provides administration-related information - * about a GemFire distributed system via the Java Management - * Extension JMX API. When a JMX <code>Agent</code> is created, it - * registers an MBean that represents {@link #getObjectName itself}. - * Click <A href="doc-files/mbeans-descriptions.html">here</A> for a - * description of the attributes, operations, and notifications of - * this and other GemFire JMX MBeans. + * A server component that provides administration-related information about a GemFire distributed + * system via the Java Management Extension JMX API. When a JMX <code>Agent</code> is created, it + * registers an MBean that represents {@link #getObjectName itself}. Click + * <A href="doc-files/mbeans-descriptions.html">here</A> for a description of the attributes, + * operations, and notifications of this and other GemFire JMX MBeans. * * <P> * - * The GemFire JMX Agent currently supports three JMX "adapters" - * through which clients can access the GemFire management beans: an - * "HTTP adapter" that allows a web browser client to view and modify - * management beans via HTTP or HTTPS, an "RMI adapter" that allows - * Java programs to access management beans using Remote Method - * Invocation, and an "SNMP adapter" that allows SNMP to access - * management beans. Information about configuring these adapters can - * be found in {@link AgentConfig}. + * The GemFire JMX Agent currently supports three JMX "adapters" through which clients can access + * the GemFire management beans: an "HTTP adapter" that allows a web browser client to view and + * modify management beans via HTTP or HTTPS, an "RMI adapter" that allows Java programs to access + * management beans using Remote Method Invocation, and an "SNMP adapter" that allows SNMP to access + * management beans. Information about configuring these adapters can be found in + * {@link AgentConfig}. * * <P> * - * In most distributed caching architectures, JMX administration - * agents are run in their own processes. A stand-alone JMX agent is - * managed using the <code>agent</code> command line utility: + * In most distributed caching architectures, JMX administration agents are run in their own + * processes. A stand-alone JMX agent is managed using the <code>agent</code> command line utility: * * <PRE> * $ agent start * </PRE> * - * This class allows a GemFire application VM to host a JMX management - * agent. Architectures with "co-located" JMX agents reduce the - * number of overall proceses required. However, hosting a JMX - * management agent in the same VM as a GemFire application is not - * generally recommended because it adds extra burden to an - * application VM and in the event that the application VM exits the + * This class allows a GemFire application VM to host a JMX management agent. Architectures with + * "co-located" JMX agents reduce the number of overall proceses required. However, hosting a JMX + * management agent in the same VM as a GemFire application is not generally recommended because it + * adds extra burden to an application VM and in the event that the application VM exits the * administration information will no longer be available. * * @see AgentConfig * @see AgentFactory * * @since GemFire 4.0 - * @deprecated as of 7.0 use the <code><a href="{@docRoot}/org/apache/geode/management/package-summary.html">management</a></code> package instead + * @deprecated as of 7.0 use the <code><a href= + * "{@docRoot}/org/apache/geode/management/package-summary.html">management</a></code> + * package instead */ public interface Agent { /** Lookup name for RMIConnector when rmi-registry-enabled is true */ public static final String JNDI_NAME = "/jmxconnector"; - ////////////////////// Instance Methods ////////////////////// + ////////////////////// Instance Methods ////////////////////// /** * Returns the configuration object for this JMX Agent. @@ -82,77 +75,65 @@ public interface Agent { public AgentConfig getConfig(); /** - * Starts this JMX Agent and its associated adapters. This method - * does not {@linkplain #connectToSystem connect} to the distributed - * system. + * Starts this JMX Agent and its associated adapters. This method does not + * {@linkplain #connectToSystem connect} to the distributed system. */ public void start(); /** - * Returns the JMX <code>MBeanServer</code> with which GemFire - * MBeans are registered or <code>null</code> if this - * <code>Agent</code> is not started. + * Returns the JMX <code>MBeanServer</code> with which GemFire MBeans are registered or + * <code>null</code> if this <code>Agent</code> is not started. */ public MBeanServer getMBeanServer(); /** - * {@linkplain #disconnectFromSystem Disconnects} from the - * distributed system and stops this JMX Agent and all of its - * associated adapters. + * {@linkplain #disconnectFromSystem Disconnects} from the distributed system and stops this JMX + * Agent and all of its associated adapters. */ public void stop(); /** - * Returns the <code>ObjectName</code> of the JMX management bean - * that represents this agent or <code>null</code> if this - * <code>Agent</code> has not been started. + * Returns the <code>ObjectName</code> of the JMX management bean that represents this agent or + * <code>null</code> if this <code>Agent</code> has not been started. */ public ObjectName getObjectName(); /** - * Returns whether or not this JMX <code>Agent</code> is currently - * providing information about a distributed system. + * Returns whether or not this JMX <code>Agent</code> is currently providing information about a + * distributed system. */ public boolean isConnected(); /** - * Connects to the distributed system described by this <code>Agent</code>'s - * configuration. + * Connects to the distributed system described by this <code>Agent</code>'s configuration. * - * @return The object name of the system that the <code>Agent</code> - * is now connected to. + * @return The object name of the system that the <code>Agent</code> is now connected to. */ - public ObjectName connectToSystem() - throws AdminException, MalformedObjectNameException; + public ObjectName connectToSystem() throws AdminException, MalformedObjectNameException; /** - * Returns the <code>AdminDistributedSystem</code> that underlies - * this JMX <code>Agent</code> or <code>null</code> is this agent is - * not {@linkplain #isConnected connected}. + * Returns the <code>AdminDistributedSystem</code> that underlies this JMX <code>Agent</code> or + * <code>null</code> is this agent is not {@linkplain #isConnected connected}. */ public AdminDistributedSystem getDistributedSystem(); /** - * Returns the object name of the JMX MBean that represents the - * distributed system administered by this <code>Agent</code> or - * <code>null</code> if this <code>Agent</code> has not {@linkplain - * #connectToSystem connected} to the distributed system. + * Returns the object name of the JMX MBean that represents the distributed system administered by + * this <code>Agent</code> or <code>null</code> if this <code>Agent</code> has not + * {@linkplain #connectToSystem connected} to the distributed system. */ - public ObjectName manageDistributedSystem() - throws MalformedObjectNameException; + public ObjectName manageDistributedSystem() throws MalformedObjectNameException; /** - * Disconnects this agent from the distributed system and - * unregisters the management beans that provided information about - * it. However, this agent's adapters are not stopped and it is - * possible to reconfigure this <code>Agent</code> to connect to - * another distributed system. + * Disconnects this agent from the distributed system and unregisters the management beans that + * provided information about it. However, this agent's adapters are not stopped and it is + * possible to reconfigure this <code>Agent</code> to connect to another distributed system. */ public void disconnectFromSystem(); /** - * Saves the configuration for this <code>Agent</code> to the file - * specified by @link AgentConfig#getPropertyFile. + * Saves the configuration for this <code>Agent</code> to the file specified by @link + * AgentConfig#getPropertyFile. */ public void saveProperties(); http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8bf39571/geode-core/src/main/java/org/apache/geode/admin/jmx/AgentConfig.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/org/apache/geode/admin/jmx/AgentConfig.java b/geode-core/src/main/java/org/apache/geode/admin/jmx/AgentConfig.java index b2f04c8..29f0751 100644 --- a/geode-core/src/main/java/org/apache/geode/admin/jmx/AgentConfig.java +++ b/geode-core/src/main/java/org/apache/geode/admin/jmx/AgentConfig.java @@ -1,280 +1,259 @@ /* - * 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 + * 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 + * 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. + * 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.geode.admin.jmx; import org.apache.geode.admin.DistributedSystemConfig; import org.apache.geode.distributed.internal.DistributionConfig; -//import org.apache.geode.admin.internal.InetAddressUtil; +// import org.apache.geode.admin.internal.InetAddressUtil; /** - * A configuration object for a JMX administration {@linkplain Agent - * agent} that is hosted by a GemFire application VM. A file named - * {@link #DEFAULT_PROPERTY_FILE "agent.properties"} can be used to - * override the default values of <code>AgentConfig</code> attributes. - * The "gfAgentPropertyFile" {@linkplain System#getProperty(java.lang.String) system - * property} can be used to specify an agent properties file other - * than "agent.properties". System properties prefixed with - * {@linkplain #SYSTEM_PROPERTY_PREFIX "gemfire.agent."} can be used to - * override the values in the properties file. For instance - * "-Dgemfire.agent.http-port=8081" can be used to override the - * default port for the HTTP adapter. Configuration related to the - * distributed system that the JMX agent administers is inherited from - * and described in <code>AgentConfig</code>'s superinterface, {@link - * DistributedSystemConfig}. + * A configuration object for a JMX administration {@linkplain Agent agent} that is hosted by a + * GemFire application VM. A file named {@link #DEFAULT_PROPERTY_FILE "agent.properties"} can be + * used to override the default values of <code>AgentConfig</code> attributes. The + * "gfAgentPropertyFile" {@linkplain System#getProperty(java.lang.String) system property} can be + * used to specify an agent properties file other than "agent.properties". System properties + * prefixed with {@linkplain #SYSTEM_PROPERTY_PREFIX "gemfire.agent."} can be used to override the + * values in the properties file. For instance "-Dgemfire.agent.http-port=8081" can be used to + * override the default port for the HTTP adapter. Configuration related to the distributed system + * that the JMX agent administers is inherited from and described in <code>AgentConfig</code>'s + * superinterface, {@link DistributedSystemConfig}. * * <P> * - * An <code>AgentConfig</code> can be modified using a number of - * mutator methods until it is used to create an <code>Agent</code>. - * After that, attempts to modify most attributes in the - * <code>AgentConfig</code> will result in an {@link - * IllegalStateException} being thrown. If you wish to use the same - * <code>AgentConfig</code> to configure multiple <code>Agent</code>s, - * a copy of the <code>AgentConfig</code> object can be made by - * invoking its {@link #clone} method. + * An <code>AgentConfig</code> can be modified using a number of mutator methods until it is used to + * create an <code>Agent</code>. After that, attempts to modify most attributes in the + * <code>AgentConfig</code> will result in an {@link IllegalStateException} being thrown. If you + * wish to use the same <code>AgentConfig</code> to configure multiple <code>Agent</code>s, a copy + * of the <code>AgentConfig</code> object can be made by invoking its {@link #clone} method. * * <P> * * <B>JMX Administation Agent Configuration Properties</B> * * <dl> - * <a name="auto-connect"><dt>{@linkplain #AUTO_CONNECT_NAME auto-connect}</dt></a> - * <dd><U>Description</U>: whether or not a JMX agent will - * automatically connect to the distributed system it is configured to - * administer.</dd> - * <dd><U>{@linkplain #DEFAULT_AUTO_CONNECT Default}</U>: false</dd> + * <a name="auto-connect"> + * <dt>{@linkplain #AUTO_CONNECT_NAME auto-connect}</dt></a> + * <dd><U>Description</U>: whether or not a JMX agent will automatically connect to the distributed + * system it is configured to administer.</dd> + * <dd><U>{@linkplain #DEFAULT_AUTO_CONNECT Default}</U>: false</dd> * </dl> * * <B>JMX Agent SSL Configuration Properties</B> * * <P> * - * These parameters configure sockets that are created by the GemFire - * JMX Agent regardless of which adapters are enabled. These setting - * apply to all adapters. For example, if clients connect to the RMI - * adapter using SSL, then clients must also connect to the HTTP - * adapter using SSL (HTTPS). Note that these configuration - * attributes do <b>not</b> effect how the agent connects to the - * distributed system it administers, only how JMX clients connect to - * the agent. + * These parameters configure sockets that are created by the GemFire JMX Agent regardless of which + * adapters are enabled. These setting apply to all adapters. For example, if clients connect to the + * RMI adapter using SSL, then clients must also connect to the HTTP adapter using SSL (HTTPS). Note + * that these configuration attributes do <b>not</b> effect how the agent connects to the + * distributed system it administers, only how JMX clients connect to the agent. * * <dl> - * <a name="agent-ssl-enabled"><dt>{@linkplain #AGENT_SSL_ENABLED_NAME agent-ssl-enabled}</dt></a> - * <dd><U>Description</U>: whether or not connections to the JMX agent - * require SSL - * </dd> - * <dd><U>{@linkplain #DEFAULT_AGENT_SSL_ENABLED Default}</U>: false</dd> + * <a name="agent-ssl-enabled"> + * <dt>{@linkplain #AGENT_SSL_ENABLED_NAME agent-ssl-enabled}</dt></a> + * <dd><U>Description</U>: whether or not connections to the JMX agent require SSL</dd> + * <dd><U>{@linkplain #DEFAULT_AGENT_SSL_ENABLED Default}</U>: false</dd> * </dl> * * <dl> - * <a name="agent-ssl-protocols"><dt>{@linkplain #AGENT_SSL_PROTOCOLS_NAME agent-ssl-protocols}</dt></a> - * <dd><U>Description</U>: the SSL protocols to be used when connecting - * to the JMX agent - * </dd> - * <dd><U>{@linkplain #DEFAULT_AGENT_SSL_PROTOCOLS Default}</U>: any</dd> + * <a name="agent-ssl-protocols"> + * <dt>{@linkplain #AGENT_SSL_PROTOCOLS_NAME agent-ssl-protocols}</dt></a> + * <dd><U>Description</U>: the SSL protocols to be used when connecting to the JMX agent</dd> + * <dd><U>{@linkplain #DEFAULT_AGENT_SSL_PROTOCOLS Default}</U>: any</dd> * </dl> * * <dl> - * <a name="agent-ssl-ciphers"><dt>{@linkplain #AGENT_SSL_CIPHERS_NAME agent-ssl-ciphers}</dt></a> - * <dd><U>Description</U>: the SSL ciphers to be used when connecting - * to the JMX agent - * </dd> - * <dd><U>{@linkplain #DEFAULT_AGENT_SSL_CIPHERS Default}</U>: any</dd> + * <a name="agent-ssl-ciphers"> + * <dt>{@linkplain #AGENT_SSL_CIPHERS_NAME agent-ssl-ciphers}</dt></a> + * <dd><U>Description</U>: the SSL ciphers to be used when connecting to the JMX agent</dd> + * <dd><U>{@linkplain #DEFAULT_AGENT_SSL_CIPHERS Default}</U>: any</dd> * </dl> * * <dl> - * <a name="agent-ssl-require-authentication"><dt>{@linkplain #AGENT_SSL_REQUIRE_AUTHENTICATION_NAME agent-ssl-require-authentication}</dt></a> - * <dd><U>Description</U>: whether or not SSL connections to the RMI - * adapter require authentication - * </dd> - * <dd><U>{@linkplain #DEFAULT_AGENT_SSL_REQUIRE_AUTHENTICATION Default}</U>: true</dd> + * <a name="agent-ssl-require-authentication"> + * <dt>{@linkplain #AGENT_SSL_REQUIRE_AUTHENTICATION_NAME agent-ssl-require-authentication}</dt></a> + * <dd><U>Description</U>: whether or not SSL connections to the RMI adapter require authentication + * </dd> + * <dd><U>{@linkplain #DEFAULT_AGENT_SSL_REQUIRE_AUTHENTICATION Default}</U>: true</dd> * </dl> * * <dl> - * <a name="http-ssl-require-authentication"><dt>{@linkplain #HTTP_SSL_REQUIRE_AUTHENTICATION_NAME http-ssl-require-authentication}</dt></a> - * <dd><U>Description</U>: whether or not SSL connections to the HTTP - * adapter require authentication - * </dd> - * <dd><U>{@linkplain #DEFAULT_HTTP_SSL_REQUIRE_AUTHENTICATION Default}</U>: false</dd> + * <a name="http-ssl-require-authentication"> + * <dt>{@linkplain #HTTP_SSL_REQUIRE_AUTHENTICATION_NAME http-ssl-require-authentication}</dt></a> + * <dd><U>Description</U>: whether or not SSL connections to the HTTP adapter require authentication + * </dd> + * <dd><U>{@linkplain #DEFAULT_HTTP_SSL_REQUIRE_AUTHENTICATION Default}</U>: false</dd> * </dl> * * <B>HTTP Adapter Configuration</B> * * <dl> - * <a name="http-enabled"><dt>{@linkplain #HTTP_ENABLED_NAME http-enabled}</dt></a> - * <dd><U>Description</U>: whether or not the HTTP adapter is - * enabled in the JMX agent.</dd> - * <dd><U>{@linkplain #DEFAULT_HTTP_ENABLED Default}</U>: true</dd> + * <a name="http-enabled"> + * <dt>{@linkplain #HTTP_ENABLED_NAME http-enabled}</dt></a> + * <dd><U>Description</U>: whether or not the HTTP adapter is enabled in the JMX agent.</dd> + * <dd><U>{@linkplain #DEFAULT_HTTP_ENABLED Default}</U>: true</dd> * </dl> * * <dl> - * <a name="http-port"><dt>{@linkplain #HTTP_PORT_NAME http-port}</dt></a> - * <dd><U>Description</U>: the port on which the HTTP adapter should - * listen for client connections. - * </dd> - * <dd><U>{@linkplain #DEFAULT_HTTP_PORT Default}</U>: 8080</dd> + * <a name="http-port"> + * <dt>{@linkplain #HTTP_PORT_NAME http-port}</dt></a> + * <dd><U>Description</U>: the port on which the HTTP adapter should listen for client connections. + * </dd> + * <dd><U>{@linkplain #DEFAULT_HTTP_PORT Default}</U>: 8080</dd> * </dl> * * <dl> - * <a name="http-bind-address"><dt>{@linkplain #HTTP_BIND_ADDRESS_NAME http-bind-address}</dt></a> - * <dd><U>Description</U>: the machine name or IP address to which - * the HTTP listening socket should be bound. If this value is - * "localhost", then the socket will be bound to the loopback - * address (127.0.0.1) and the adapter will only be accessible via - * the URL <code>http://localhost:8080</code>.</dd> - * <dd><U>{@linkplain #DEFAULT_HTTP_BIND_ADDRESS Default}</U>: "" - * (all network addresses)</dd> + * <a name="http-bind-address"> + * <dt>{@linkplain #HTTP_BIND_ADDRESS_NAME http-bind-address}</dt></a> + * <dd><U>Description</U>: the machine name or IP address to which the HTTP listening socket should + * be bound. If this value is "localhost", then the socket will be bound to the loopback address + * (127.0.0.1) and the adapter will only be accessible via the URL + * <code>http://localhost:8080</code>.</dd> + * <dd><U>{@linkplain #DEFAULT_HTTP_BIND_ADDRESS Default}</U>: "" (all network addresses)</dd> * </dl> * * <dl> - * <a name="http-authentication-enabled"><dt>{@linkplain #HTTP_AUTHENTICATION_ENABLED_NAME http-authentication-enabled}</dt></a> - * <dd><U>Description</U>: Whether or not connections to the HTTP - * adapter should be authenticated with a user name and password. - * </dd> - * <dd><U>{@linkplain #DEFAULT_HTTP_AUTHENTICATION_ENABLED Default}</U>: false</dd> + * <a name="http-authentication-enabled"> + * <dt>{@linkplain #HTTP_AUTHENTICATION_ENABLED_NAME http-authentication-enabled}</dt></a> + * <dd><U>Description</U>: Whether or not connections to the HTTP adapter should be authenticated + * with a user name and password.</dd> + * <dd><U>{@linkplain #DEFAULT_HTTP_AUTHENTICATION_ENABLED Default}</U>: false</dd> * </dl> * * <dl> - * <a name="http-authentication-user"><dt>{@linkplain #HTTP_AUTHENTICATION_USER_NAME http-authentication-user}</dt></a> - * <dd><U>Description</U>: the user name for authenticating secure - * communication. - * </dd> - * <dd><U>{@linkplain #DEFAULT_HTTP_AUTHENTICATION_USER Default}</U>: admin</dd> + * <a name="http-authentication-user"> + * <dt>{@linkplain #HTTP_AUTHENTICATION_USER_NAME http-authentication-user}</dt></a> + * <dd><U>Description</U>: the user name for authenticating secure communication.</dd> + * <dd><U>{@linkplain #DEFAULT_HTTP_AUTHENTICATION_USER Default}</U>: admin</dd> * </dl> * * <dl> - * <a name="http-authentication-password"><dt>{@linkplain #HTTP_AUTHENTICATION_PASSWORD_NAME http-authentication-password}</dt></a> - * <dd><U>Description</U>: the password for authenticating secure - * communication. - * </dd> - * <dd><U>{@linkplain #DEFAULT_HTTP_AUTHENTICATION_PASSWORD Default}</U>: password</dd> + * <a name="http-authentication-password"> + * <dt>{@linkplain #HTTP_AUTHENTICATION_PASSWORD_NAME http-authentication-password}</dt></a> + * <dd><U>Description</U>: the password for authenticating secure communication.</dd> + * <dd><U>{@linkplain #DEFAULT_HTTP_AUTHENTICATION_PASSWORD Default}</U>: password</dd> * </dl> * * <B>RMI Adapter Configuration Properties</B> * * <dl> - * <a name="rmi-enabled"><dt>{@linkplain #RMI_ENABLED_NAME rmi-enabled}</dt></a> - * <dd><U>Description</U>: whether or not the RMI JMX adapter is enabled - * </dd> - * <dd><U>{@linkplain #DEFAULT_RMI_ENABLED Default}</U>: true</dd> + * <a name="rmi-enabled"> + * <dt>{@linkplain #RMI_ENABLED_NAME rmi-enabled}</dt></a> + * <dd><U>Description</U>: whether or not the RMI JMX adapter is enabled</dd> + * <dd><U>{@linkplain #DEFAULT_RMI_ENABLED Default}</U>: true</dd> * </dl> * * <dl> - * <a name="rmi-registry-enabled"><dt>{@linkplain #RMI_REGISTRY_ENABLED_NAME rmi-registry-enabled}</dt></a> - * <dd><U>Description</U>: whether or not the JMX agent should start - * an RMI registry. Alternatively, a registry outside of the JMX - * agent VM can be used. - * </dd> - * <dd><U>{@linkplain #DEFAULT_RMI_REGISTRY_ENABLED Default}</U>: true</dd> + * <a name="rmi-registry-enabled"> + * <dt>{@linkplain #RMI_REGISTRY_ENABLED_NAME rmi-registry-enabled}</dt></a> + * <dd><U>Description</U>: whether or not the JMX agent should start an RMI registry. Alternatively, + * a registry outside of the JMX agent VM can be used.</dd> + * <dd><U>{@linkplain #DEFAULT_RMI_REGISTRY_ENABLED Default}</U>: true</dd> * </dl> * * <dl> - * <a name="rmi-port"><dt>{@linkplain #RMI_PORT_NAME rmi-port}</dt></a> - * <dd><U>Description</U>: the port of the RMI registry in which the - * JMX Agent should bind remote objects. - * </dd> - * <dd><U>{@linkplain #DEFAULT_RMI_PORT Default}</U>: 1099</dd> + * <a name="rmi-port"> + * <dt>{@linkplain #RMI_PORT_NAME rmi-port}</dt></a> + * <dd><U>Description</U>: the port of the RMI registry in which the JMX Agent should bind remote + * objects.</dd> + * <dd><U>{@linkplain #DEFAULT_RMI_PORT Default}</U>: 1099</dd> * </dl> * * <dl> - * <a name="rmi-server-port"><dt>{@linkplain #RMI_PORT_NAME rmi-server-port}</dt></a> - * <dd><U>Description</U>: the port to be used by the RMI Server started by - * JMX Agent. - * </dd> - * <dd><U>{@linkplain #DEFAULT_RMI_SERVER_PORT Default}</U>: 0</dd> - * </dl> + * <a name="rmi-server-port"> + * <dt>{@linkplain #RMI_PORT_NAME rmi-server-port}</dt></a> + * <dd><U>Description</U>: the port to be used by the RMI Server started by JMX Agent.</dd> + * <dd><U>{@linkplain #DEFAULT_RMI_SERVER_PORT Default}</U>: 0</dd> + * </dl> * * <dl> - * <a name="rmi-bind-address"><dt>{@linkplain #RMI_BIND_ADDRESS_NAME rmi-bind-address}</dt></a> - * <dd><U>Description</U>: the bind address on which the RMI - * registry binds its sockets. - * </dd> - * <dd><U>{@linkplain #DEFAULT_RMI_BIND_ADDRESS Default}</U>: "" - * (all network addresses)</dd> + * <a name="rmi-bind-address"> + * <dt>{@linkplain #RMI_BIND_ADDRESS_NAME rmi-bind-address}</dt></a> + * <dd><U>Description</U>: the bind address on which the RMI registry binds its sockets.</dd> + * <dd><U>{@linkplain #DEFAULT_RMI_BIND_ADDRESS Default}</U>: "" (all network addresses)</dd> * </dl> * * <B>AdventNet SNMP Adapter Configuration Properties</B> * * <dl> - * <a name="snmp-enabled"><dt>{@linkplain #SNMP_ENABLED_NAME snmp-enabled}</dt></a> - * <dd><U>Description</U>: whether or not the SNMP JMX adapter is - * enabled - * </dd> - * <dd><U>{@linkplain #DEFAULT_SNMP_ENABLED Default}</U>: false</dd> + * <a name="snmp-enabled"> + * <dt>{@linkplain #SNMP_ENABLED_NAME snmp-enabled}</dt></a> + * <dd><U>Description</U>: whether or not the SNMP JMX adapter is enabled</dd> + * <dd><U>{@linkplain #DEFAULT_SNMP_ENABLED Default}</U>: false</dd> * </dl> * * <dl> - * <a name="snmp-bind-address"><dt>{@linkplain #SNMP_BIND_ADDRESS_NAME snmp-bind-address}</dt></a> - * <dd><U>Description</U>: the host name to which sockets used by the - * SNMP adapter should be bound. - * </dd> - * <dd><U>{@linkplain #DEFAULT_SNMP_BIND_ADDRESS Default}</U>: the name of - * the local machine (not <code>localhost</code>)</dd> + * <a name="snmp-bind-address"> + * <dt>{@linkplain #SNMP_BIND_ADDRESS_NAME snmp-bind-address}</dt></a> + * <dd><U>Description</U>: the host name to which sockets used by the SNMP adapter should be bound. + * </dd> + * <dd><U>{@linkplain #DEFAULT_SNMP_BIND_ADDRESS Default}</U>: the name of the local machine (not + * <code>localhost</code>)</dd> * </dl> * * <dl> - * <a name="snmp-directory"><dt>{@linkplain #SNMP_DIRECTORY_NAME snmp-directory}</dt></a> - * <dd><U>Description</U>: the deployment directory for AdventNet - * SNMP Adaptor - * </dd> - * <dd><U>{@linkplain #DEFAULT_SNMP_DIRECTORY Default}</U>: ""</dd> + * <a name="snmp-directory"> + * <dt>{@linkplain #SNMP_DIRECTORY_NAME snmp-directory}</dt></a> + * <dd><U>Description</U>: the deployment directory for AdventNet SNMP Adaptor</dd> + * <dd><U>{@linkplain #DEFAULT_SNMP_DIRECTORY Default}</U>: ""</dd> * </dl> * * <B>JMX Agent Email Notification Properties (for statistics alerts)</B> * * <dl> - * <a name="email-notification-enabled"><dt>{@linkplain #EMAIL_NOTIFICATIONS_ENABLED_NAME email-notification-enabled}</dt></a> - * <dd><U>Description</U>: Whether or not email notifications are enabled for statistics alerts. - * </dd> - * <dd><U>{@linkplain #DEFAULT_EMAIL_NOTIFICATIONS_ENABLED Default}</U>: false</dd> + * <a name="email-notification-enabled"> + * <dt>{@linkplain #EMAIL_NOTIFICATIONS_ENABLED_NAME email-notification-enabled}</dt></a> + * <dd><U>Description</U>: Whether or not email notifications are enabled for statistics alerts. + * </dd> + * <dd><U>{@linkplain #DEFAULT_EMAIL_NOTIFICATIONS_ENABLED Default}</U>: false</dd> * </dl> * * <dl> - * <a name="email-notification-from"><dt>{@linkplain #EMAIL_NOTIFICATIONS_FROM_NAME email-notification-from}</dt></a> - * <dd><U>Description</U>: Email address to be used to send email notifications. - * </dd> - * <dd><U>{@linkplain #DEFAULT_EMAIL_FROM Default}</U>: ""</dd> + * <a name="email-notification-from"> + * <dt>{@linkplain #EMAIL_NOTIFICATIONS_FROM_NAME email-notification-from}</dt></a> + * <dd><U>Description</U>: Email address to be used to send email notifications.</dd> + * <dd><U>{@linkplain #DEFAULT_EMAIL_FROM Default}</U>: ""</dd> * </dl> * * <dl> - * <a name="email-notification-host"><dt>{@linkplain #EMAIL_NOTIFICATIONS_HOST_NAME email-notification-host}</dt></a> - * <dd><U>Description</U>: The host name of the mail server to be used for email communication. - * </dd> - * <dd><U>{@linkplain #DEFAULT_EMAIL_HOST Default}</U>: ""</dd> + * <a name="email-notification-host"> + * <dt>{@linkplain #EMAIL_NOTIFICATIONS_HOST_NAME email-notification-host}</dt></a> + * <dd><U>Description</U>: The host name of the mail server to be used for email communication.</dd> + * <dd><U>{@linkplain #DEFAULT_EMAIL_HOST Default}</U>: ""</dd> * </dl> * * <dl> - * <a name="email-notification-to"><dt>{@linkplain #EMAIL_NOTIFICATIONS_TO_LIST_NAME email-notification-to}</dt></a> - * <dd><U>Description</U>: Email address where the email notifications should be sent. - * </dd> - * <dd><U>{@linkplain #DEFAULT_EMAIL_TO_LIST Default}</U>: ""</dd> + * <a name="email-notification-to"> + * <dt>{@linkplain #EMAIL_NOTIFICATIONS_TO_LIST_NAME email-notification-to}</dt></a> + * <dd><U>Description</U>: Email address where the email notifications should be sent.</dd> + * <dd><U>{@linkplain #DEFAULT_EMAIL_TO_LIST Default}</U>: ""</dd> * </dl> * * <dl> - * <a name="state-save-file"><dt>{@linkplain #STATE_SAVE_FILE_NAME state-save-file}</dt></a> - * <dd><U>Description</U>: The name of the file to be used for saving agent state. The file - is stored in the same directory in which the agent.properties file is located - * </dd> - * <dd><U>{@linkplain #DEFAULT_STATE_SAVE_FILE Default}</U>: ""</dd> + * <a name="state-save-file"> + * <dt>{@linkplain #STATE_SAVE_FILE_NAME state-save-file}</dt></a> + * <dd><U>Description</U>: The name of the file to be used for saving agent state. The file is + * stored in the same directory in which the agent.properties file is located</dd> + * <dd><U>{@linkplain #DEFAULT_STATE_SAVE_FILE Default}</U>: ""</dd> * </dl> * * * @since GemFire 4.0 - * @deprecated as of 7.0 use the <code><a href="{@docRoot}/org/apache/geode/management/package-summary.html">management</a></code> package instead + * @deprecated as of 7.0 use the <code><a href= + * "{@docRoot}/org/apache/geode/management/package-summary.html">management</a></code> + * package instead */ public interface AgentConfig extends DistributedSystemConfig { @@ -286,29 +265,29 @@ public interface AgentConfig extends DistributedSystemConfig { /** The default name for file that has "agent state saved serialized" */ public static final String DEFAULT_STATE_SAVE_FILE = "agent.ser"; - + /** The name of the "auto-connect" property */ public static final String AUTO_CONNECT_NAME = "auto-connect"; - /** The default value of the "auto-connect" property */ + /** The default value of the "auto-connect" property */ public static final boolean DEFAULT_AUTO_CONNECT = true; // ------------------------------------------------------------------------- - // HttpAdaptor properties... + // HttpAdaptor properties... // ------------------------------------------------------------------------- - + /** The name of the "httpEnabled" property */ public static final String HTTP_ENABLED_NAME = "http-enabled"; - /** The default value of the "httpEnabled" property */ + /** The default value of the "httpEnabled" property */ public static final boolean DEFAULT_HTTP_ENABLED = true; - + /** The name of the "httpBindAddress" property */ public static final String HTTP_BIND_ADDRESS_NAME = "http-bind-address"; /** The default value of the "httpBindAddress" property */ public static final String DEFAULT_HTTP_BIND_ADDRESS = ""; - + /** The name of the "httpPort" property */ public static final String HTTP_PORT_NAME = "http-port"; @@ -322,86 +301,84 @@ public interface AgentConfig extends DistributedSystemConfig { public static final int MAX_HTTP_PORT = 65535; /** The name of the "state-save-file-name" property */ - public static final String STATE_SAVE_FILE_NAME = - "state-save-file"; + public static final String STATE_SAVE_FILE_NAME = "state-save-file"; /** The name of the "http-authentication-enabled" property */ - public static final String HTTP_AUTHENTICATION_ENABLED_NAME = - "http-authentication-enabled"; + public static final String HTTP_AUTHENTICATION_ENABLED_NAME = "http-authentication-enabled"; - /** The default value of the "http-authentication-enabled" property - * */ + /** + * The default value of the "http-authentication-enabled" property + */ public static final boolean DEFAULT_HTTP_AUTHENTICATION_ENABLED = false; /** The name of the "http-authentication-user" property */ - public static final String HTTP_AUTHENTICATION_USER_NAME = - "http-authentication-user"; + public static final String HTTP_AUTHENTICATION_USER_NAME = "http-authentication-user"; - /** The default value of the "http-authentication-user" property */ + /** The default value of the "http-authentication-user" property */ public static final String DEFAULT_HTTP_AUTHENTICATION_USER = "admin"; /** The name of the "http-authentication-password" property */ - public static final String HTTP_AUTHENTICATION_PASSWORD_NAME = - "http-authentication-password"; + public static final String HTTP_AUTHENTICATION_PASSWORD_NAME = "http-authentication-password"; - /** The default value of the "http-authentication-password" property - * */ - public static final String DEFAULT_HTTP_AUTHENTICATION_PASSWORD = - "password"; + /** + * The default value of the "http-authentication-password" property + */ + public static final String DEFAULT_HTTP_AUTHENTICATION_PASSWORD = "password"; /** The name of the "email-notification-enabled" property */ - public static final String EMAIL_NOTIFICATIONS_ENABLED_NAME = - "email-notification-enabled"; + public static final String EMAIL_NOTIFICATIONS_ENABLED_NAME = "email-notification-enabled"; - /** The default value of the "email-notification-enabled" property - * */ + /** + * The default value of the "email-notification-enabled" property + */ public static final boolean DEFAULT_EMAIL_NOTIFICATIONS_ENABLED = false; /** The name of the "email-notification-from" property */ - public static final String EMAIL_NOTIFICATIONS_FROM_NAME = - "email-notification-from"; + public static final String EMAIL_NOTIFICATIONS_FROM_NAME = "email-notification-from"; - /** The default value of the "email-notification-from" property - * */ + /** + * The default value of the "email-notification-from" property + */ public static final String DEFAULT_EMAIL_FROM = ""; /** The name of the "email-notification-host" property */ - public static final String EMAIL_NOTIFICATIONS_HOST_NAME = - "email-notification-host"; + public static final String EMAIL_NOTIFICATIONS_HOST_NAME = "email-notification-host"; - /** The default value of the "email-notification-host" property - * */ + /** + * The default value of the "email-notification-host" property + */ public static final String DEFAULT_EMAIL_HOST = ""; /** The name of the "email-notification-to" property */ - public static final String EMAIL_NOTIFICATIONS_TO_LIST_NAME = - "email-notification-to"; + public static final String EMAIL_NOTIFICATIONS_TO_LIST_NAME = "email-notification-to"; - /** The default value of the "email-notification-to" property - * */ + /** + * The default value of the "email-notification-to" property + */ public static final String DEFAULT_EMAIL_TO_LIST = ""; // ------------------------------------------------------------------------- - // RMIConnectorServer properties... + // RMIConnectorServer properties... // ------------------------------------------------------------------------- - + /** The name of the "rmiEnabled" property */ public static final String RMI_ENABLED_NAME = "rmi-enabled"; - /** The default value of the {@linkplain #RMI_ENABLED_NAME rmi-enabled} property */ + /** The default value of the {@linkplain #RMI_ENABLED_NAME rmi-enabled} property */ public static final boolean DEFAULT_RMI_ENABLED = true; - + /** The name of the "rmi-registry-enabled" property */ - public static final String RMI_REGISTRY_ENABLED_NAME = - "rmi-registry-enabled"; + public static final String RMI_REGISTRY_ENABLED_NAME = "rmi-registry-enabled"; - /** The default value of the {@linkplain #RMI_REGISTRY_ENABLED_NAME rmi-registry-enabled} property*/ + /** + * The default value of the {@linkplain #RMI_REGISTRY_ENABLED_NAME rmi-registry-enabled} property + */ public static final boolean DEFAULT_RMI_REGISTRY_ENABLED = true; - + /** The name of the "rmiBindAddress" property */ public static final String RMI_BIND_ADDRESS_NAME = "rmi-bind-address"; - /** The default value of the {@linkplain #RMI_BIND_ADDRESS_NAME rmi-bind-address} property */ + /** The default value of the {@linkplain #RMI_BIND_ADDRESS_NAME rmi-bind-address} property */ public static final String DEFAULT_RMI_BIND_ADDRESS = ""; /** The name of the "rmiPort" property */ @@ -409,44 +386,43 @@ public interface AgentConfig extends DistributedSystemConfig { /** The default value of the {@linkplain #RMI_PORT_NAME rmi-port} property (1099) */ public static final int DEFAULT_RMI_PORT = 1099; - - /** + + /** * The name of the "rmi-server-port" property * * @since GemFire 6.5 */ public static final String RMI_SERVER_PORT_NAME = "rmi-server-port"; - /** - * The default value of the {@linkplain #RMI_SERVER_PORT_NAME rmi-server-port} - * property (0) + /** + * The default value of the {@linkplain #RMI_SERVER_PORT_NAME rmi-server-port} property (0) * * @since GemFire 6.5 */ public static final int DEFAULT_RMI_SERVER_PORT = 0; /** - * The minimum value for {@linkplain #RMI_PORT_NAME rmi-port} or - * {@linkplain #RMI_SERVER_PORT_NAME rmi-server-port} (0) + * The minimum value for {@linkplain #RMI_PORT_NAME rmi-port} or {@linkplain #RMI_SERVER_PORT_NAME + * rmi-server-port} (0) */ public static final int MIN_RMI_PORT = 0; /** - * The maximum value for {@linkplain #RMI_PORT_NAME rmi-port} or - * {@linkplain #RMI_SERVER_PORT_NAME rmi-server-port} (65535) + * The maximum value for {@linkplain #RMI_PORT_NAME rmi-port} or {@linkplain #RMI_SERVER_PORT_NAME + * rmi-server-port} (65535) */ public static final int MAX_RMI_PORT = 65535; - + // ------------------------------------------------------------------------- - // AdventNetSNMPAdaptor properties... + // AdventNetSNMPAdaptor properties... // ------------------------------------------------------------------------- - + /** The name of the "snmpEnabled" property */ public static final String SNMP_ENABLED_NAME = "snmp-enabled"; - /** The default value of the "snmpEnabled" property */ + /** The default value of the "snmpEnabled" property */ public static final boolean DEFAULT_SNMP_ENABLED = false; - + /** The name of the "snmpBindAddress" property */ public static final String SNMP_BIND_ADDRESS_NAME = "snmp-bind-address"; @@ -456,60 +432,62 @@ public interface AgentConfig extends DistributedSystemConfig { /** The name of the "snmpDirectory" property */ public static final String SNMP_DIRECTORY_NAME = "snmp-directory"; - /** The default value of the "snmpDirectory" property */ + /** The default value of the "snmpDirectory" property */ public static final String DEFAULT_SNMP_DIRECTORY = ""; // ------------------------------------------------------------------------- - // JMX SSL properties... + // JMX SSL properties... // ------------------------------------------------------------------------- /** The name of the "agent-ssl-enabled" property */ public static final String AGENT_SSL_ENABLED_NAME = "agent-ssl-enabled"; - /** The default value of the "agent-ssl-enabled" property */ + /** The default value of the "agent-ssl-enabled" property */ public static final boolean DEFAULT_AGENT_SSL_ENABLED = false; /** The name of the "agent-ssl-protocols" property */ public static final String AGENT_SSL_PROTOCOLS_NAME = "agent-ssl-protocols"; - /** The default value of the "agent-ssl-protocols" property */ + /** The default value of the "agent-ssl-protocols" property */ public static final String DEFAULT_AGENT_SSL_PROTOCOLS = "any"; /** The name of the "agent-ssl-ciphers" property */ public static final String AGENT_SSL_CIPHERS_NAME = "agent-ssl-ciphers"; - /** The default value of the "agent-ssl-ciphers" property */ + /** The default value of the "agent-ssl-ciphers" property */ public static final String DEFAULT_AGENT_SSL_CIPHERS = "any"; /** The name of the "agent-ssl-require-authentication" property */ public static final String AGENT_SSL_REQUIRE_AUTHENTICATION_NAME = - "agent-ssl-require-authentication"; + "agent-ssl-require-authentication"; - /** The default value of the "agent-ssl-require-authentication" - * property */ + /** + * The default value of the "agent-ssl-require-authentication" property + */ public static final boolean DEFAULT_AGENT_SSL_REQUIRE_AUTHENTICATION = true; - + /** The name of the "http-ssl-require-authentication" property */ public static final String HTTP_SSL_REQUIRE_AUTHENTICATION_NAME = - "http-ssl-require-authentication"; + "http-ssl-require-authentication"; - /** The default value of the "http-ssl-require-authentication" - * property */ + /** + * The default value of the "http-ssl-require-authentication" property + */ public static final boolean DEFAULT_HTTP_SSL_REQUIRE_AUTHENTICATION = false; - ////////////////////// Instance Methods ////////////////////// + ////////////////////// Instance Methods ////////////////////// /** - * Returns whether or not the JMX agent will automatically connect - * to the distributed system it administers. + * Returns whether or not the JMX agent will automatically connect to the distributed system it + * administers. * * See <a href="#auto-connect">description</a> above. */ public boolean getAutoConnect(); /** - * Sets whether or not the JMX agent will automatically connect - * to the distributed system it administers. + * Sets whether or not the JMX agent will automatically connect to the distributed system it + * administers. * * See <a href="#auto-connect">description</a> above. */ @@ -544,67 +522,58 @@ public interface AgentConfig extends DistributedSystemConfig { public void setHttpPort(int port); /** - * Returns the bind address to which the HTTP adapter's listening - * socket is bound. + * Returns the bind address to which the HTTP adapter's listening socket is bound. * * See <a href="#http-bind-address">description</a> above. */ public String getHttpBindAddress(); /** - * Sets the bind address to which the HTTP adapter's listening - * socket is bound. + * Sets the bind address to which the HTTP adapter's listening socket is bound. * * See <a href="#http-bind-address">description</a> above. */ public void setHttpBindAddress(String address); /** - * Returns whether or not the HTTP adapter authenticates - * connections. + * Returns whether or not the HTTP adapter authenticates connections. * - * See <a href="#http-authentication-enabled">description</a> - * above. - */ + * See <a href="#http-authentication-enabled">description</a> above. + */ public boolean isHttpAuthEnabled(); /** * Sets whether or not the HTTP adapter authenticates connections. * - * See <a href="#http-authentication-enabled">description</a> - * above. + * See <a href="#http-authentication-enabled">description</a> above. */ public void setHttpAuthEnabled(boolean enabled); /** * Returns the user name for HTTP adapter authentication. * - * See <a href="#http-authentication-user">description</a> - * above. + * See <a href="#http-authentication-user">description</a> above. */ public String getHttpAuthUser(); - + /** * Sets the user name for HTTP adapter authentication. * - * See <a href="#http-authentication-user">description</a> - * above. + * See <a href="#http-authentication-user">description</a> above. */ public void setHttpAuthUser(String user); /** * Returns the password for HTTP adapter authentication. * - * See <a href="#http-authentication-password">description</a> - * above. + * See <a href="#http-authentication-password">description</a> above. */ public String getHttpAuthPassword(); - + /** * Sets the password for HTTP adapter authentication. * - * See <a href="#http-authentication-password">description</a> - * above. + * See <a href="#http-authentication-password">description</a> above. */ public void setHttpAuthPassword(String password); @@ -649,7 +618,7 @@ public interface AgentConfig extends DistributedSystemConfig { * See <a href="#rmi-port">description</a> above. */ public void setRmiPort(int port); - + /** * Returns the port of the RMI Connector Server. * @@ -665,22 +634,20 @@ public interface AgentConfig extends DistributedSystemConfig { * * See <a href="#rmi-server-port">description</a> above. * - * @param port rmi-server-port to set. + * @param port rmi-server-port to set. * @since GemFire 6.5 */ public void setRmiServerPort(int port); /** - * Returns the bind address to which the RMI adapter's listening - * sockets are bound. + * Returns the bind address to which the RMI adapter's listening sockets are bound. * * See <a href="#rmi-bind-address">description</a> above. */ public String getRmiBindAddress(); /** - * Sets the bind address to which the RMI adapter's listening - * sockets are bound. + * Sets the bind address to which the RMI adapter's listening sockets are bound. * * See <a href="#rmi-bind-address">description</a> above. */ @@ -727,7 +694,7 @@ public interface AgentConfig extends DistributedSystemConfig { * See <a href="#snmp-directory">description</a> above. */ public void setSnmpDirectory(String snmpDirectory); - + /** * Returns whether or not SSL is required for the JMX agent. * @@ -771,32 +738,28 @@ public interface AgentConfig extends DistributedSystemConfig { public void setAgentSSLCiphers(String ciphers); /** - * Returns whether SSL authentication is used when connecting to the - * RMI connector. + * Returns whether SSL authentication is used when connecting to the RMI connector. * * See <a href="#agent-ssl-require-authentication">description</a> above. */ public boolean isAgentSSLRequireAuth(); - + /** - * Sets whether SSL authentication is used when connecting to the - * RMI connector. + * Sets whether SSL authentication is used when connecting to the RMI connector. * * See <a href="#agent-ssl-require-authentication">description</a> above. */ public void setAgentSSLRequireAuth(boolean require); /** - * Returns whether SSL authentication is used when connecting to the - * HTTP connector. + * Returns whether SSL authentication is used when connecting to the HTTP connector. * * See <a href="#http-ssl-require-authentication">description</a> above. */ public boolean isHttpSSLRequireAuth(); - + /** - * Sets whether SSL authentication is used when connecting to the - * HTTP connector. + * Sets whether SSL authentication is used when connecting to the HTTP connector. * * See <a href="#http-ssl-require-authentication">description</a> above. */ @@ -822,7 +785,7 @@ public interface AgentConfig extends DistributedSystemConfig { * See <a href="#email-notification-from">description</a> above. */ public String getEmailNotificationFrom(); - + /** * Sets the EmailID from whom notification emails are sent. * @@ -836,7 +799,7 @@ public interface AgentConfig extends DistributedSystemConfig { * See <a href="#email-notification-host">description</a> above. */ public String getEmailNotificationHost(); - + /** * Sets the Host Name from whom notification emails are sent. * @@ -845,21 +808,19 @@ public interface AgentConfig extends DistributedSystemConfig { public void setEmailNotificationHost(String hostName); /** - * Returns the comma separated EmailID list to whom notification - * emails are sent. + * Returns the comma separated EmailID list to whom notification emails are sent. * * See <a href="#email-notification-to">description</a> above. */ public String getEmailNotificationToList(); - + /** - * Sets the EmailID from whom notification emails are sent as a - * comma separated list. + * Sets the EmailID from whom notification emails are sent as a comma separated list. * * See <a href="#email-notification-to">description</a> above. */ public void setEmailNotificationToList(String emailIDs); - + /** * Returns the name of the file to be used for saving agent state * @@ -875,9 +836,9 @@ public interface AgentConfig extends DistributedSystemConfig { public void setStateSaveFile(String file); /** - * Returns an <code>AgentConfig</code> with the same configuration - * as this <code>AgentConfig</code>. + * Returns an <code>AgentConfig</code> with the same configuration as this + * <code>AgentConfig</code>. */ - public Object clone() throws CloneNotSupportedException; + public Object clone() throws CloneNotSupportedException; } http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8bf39571/geode-core/src/main/java/org/apache/geode/admin/jmx/AgentFactory.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/org/apache/geode/admin/jmx/AgentFactory.java b/geode-core/src/main/java/org/apache/geode/admin/jmx/AgentFactory.java index 69bae36..5228c6b 100644 --- a/geode-core/src/main/java/org/apache/geode/admin/jmx/AgentFactory.java +++ b/geode-core/src/main/java/org/apache/geode/admin/jmx/AgentFactory.java @@ -1,22 +1,20 @@ /* - * 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 + * 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 + * 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. + * 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.geode.admin.jmx; -//import org.apache.geode.admin.AdminDistributedSystem; +// import org.apache.geode.admin.AdminDistributedSystem; import org.apache.geode.admin.AdminException; import org.apache.geode.admin.jmx.internal.AgentConfigImpl; import org.apache.geode.admin.jmx.internal.AgentImpl; @@ -25,26 +23,25 @@ import org.apache.geode.admin.jmx.internal.AgentImpl; * A factory class that creates JMX administration entities. * * @since GemFire 4.0 - * @deprecated as of 7.0 use the <code><a href="{@docRoot}/org/apache/geode/management/package-summary.html">management</a></code> package instead + * @deprecated as of 7.0 use the <code><a href= + * "{@docRoot}/org/apache/geode/management/package-summary.html">management</a></code> + * package instead */ public class AgentFactory { /** - * Defines a "default" GemFire JMX administration agent - * configuration. + * Defines a "default" GemFire JMX administration agent configuration. */ public static AgentConfig defineAgent() { return new AgentConfigImpl(); } /** - * Creates an unstarted GemFire JMX administration agent with the - * given configuration. + * Creates an unstarted GemFire JMX administration agent with the given configuration. * * @see Agent#start */ - public static Agent getAgent(AgentConfig config) - throws AdminException { + public static Agent getAgent(AgentConfig config) throws AdminException { return new AgentImpl((AgentConfigImpl) config); }
