http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8bf39571/geode-core/src/main/java/org/apache/geode/admin/CacheServerConfig.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/org/apache/geode/admin/CacheServerConfig.java b/geode-core/src/main/java/org/apache/geode/admin/CacheServerConfig.java index fc4ce0f..389d6bc 100644 --- a/geode-core/src/main/java/org/apache/geode/admin/CacheServerConfig.java +++ b/geode-core/src/main/java/org/apache/geode/admin/CacheServerConfig.java @@ -1,24 +1,22 @@ /* - * 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; /** - * Configuration for a GemFire cache server that is managed by the - * administration API. The cache server may or may not be running. + * Configuration for a GemFire cache server that is managed by the administration API. The cache + * server may or may not be running. * * @see AdminDistributedSystem#addCacheServer() * @@ -28,27 +26,25 @@ package org.apache.geode.admin; @Deprecated public interface CacheServerConfig extends CacheVmConfig { /** - * Returns the <code>cache.xml</code> declarative caching - * initialization file used to configure this cache server VM. By - * default, a cache server VM is started without an XML file. + * Returns the <code>cache.xml</code> declarative caching initialization file used to configure + * this cache server VM. By default, a cache server VM is started without an XML file. */ public String getCacheXMLFile(); /** - * Sets the <code>cache.xml</code> declarative caching - * initialization file used to configure this cache server VM. + * Sets the <code>cache.xml</code> declarative caching initialization file used to configure this + * cache server VM. */ public void setCacheXMLFile(String cacheXml); /** - * Returns the location(s) of user classes (such as cache loaders) - * required by the cache server VM. + * Returns the location(s) of user classes (such as cache loaders) required by the cache server + * VM. */ public String getClassPath(); /** - * Sets the location(s) of user classes (such as cache loaders) - * required by the cache server VM. + * Sets the location(s) of user classes (such as cache loaders) required by the cache server VM. */ public void setClassPath(String classpath); }
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8bf39571/geode-core/src/main/java/org/apache/geode/admin/CacheVm.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/org/apache/geode/admin/CacheVm.java b/geode-core/src/main/java/org/apache/geode/admin/CacheVm.java index 5bfeddc..30d8701 100755 --- a/geode-core/src/main/java/org/apache/geode/admin/CacheVm.java +++ b/geode-core/src/main/java/org/apache/geode/admin/CacheVm.java @@ -1,33 +1,31 @@ /* - * 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; /** - * A dedicated cache server VM that is managed by the administration - * API. - * <p>Note that this may not represent an instance of - * {@link org.apache.geode.cache.server.CacheServer}. It is possible for - * a cache VM to be started but for it not to listen for client connections - * in which case it is not a - * {@link org.apache.geode.cache.server.CacheServer} - * but is an instance of this interface. + * A dedicated cache server VM that is managed by the administration API. + * <p> + * Note that this may not represent an instance of + * {@link org.apache.geode.cache.server.CacheServer}. It is possible for a cache VM to be started + * but for it not to listen for client connections in which case it is not a + * {@link org.apache.geode.cache.server.CacheServer} but is an instance of this interface. * * @since GemFire 5.7 - * @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 CacheVm extends SystemMember, ManagedEntity { /** http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8bf39571/geode-core/src/main/java/org/apache/geode/admin/CacheVmConfig.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/org/apache/geode/admin/CacheVmConfig.java b/geode-core/src/main/java/org/apache/geode/admin/CacheVmConfig.java index e7068bc..81f4a38 100755 --- a/geode-core/src/main/java/org/apache/geode/admin/CacheVmConfig.java +++ b/geode-core/src/main/java/org/apache/geode/admin/CacheVmConfig.java @@ -1,53 +1,51 @@ /* - * 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; /** - * Configuration for a GemFire cache server VM that is managed by the - * administration API. The VM may or may not be running. + * Configuration for a GemFire cache server VM that is managed by the administration API. The VM may + * or may not be running. * * @see AdminDistributedSystem#addCacheVm() * * @since GemFire 5.7 - * @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 CacheVmConfig extends ManagedEntityConfig { /** - * Returns the <code>cache.xml</code> declarative caching - * initialization file used to configure this cache server VM. By - * default, a cache server VM is started without an XML file. + * Returns the <code>cache.xml</code> declarative caching initialization file used to configure + * this cache server VM. By default, a cache server VM is started without an XML file. */ public String getCacheXMLFile(); /** - * Sets the <code>cache.xml</code> declarative caching - * initialization file used to configure this cache server VM. + * Sets the <code>cache.xml</code> declarative caching initialization file used to configure this + * cache server VM. */ public void setCacheXMLFile(String cacheXml); /** - * Returns the location(s) of user classes (such as cache loaders) - * required by the cache server VM. + * Returns the location(s) of user classes (such as cache loaders) required by the cache server + * VM. */ public String getClassPath(); /** - * Sets the location(s) of user classes (such as cache loaders) - * required by the cache server VM. + * Sets the location(s) of user classes (such as cache loaders) required by the cache server VM. */ public void setClassPath(String classpath); } http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8bf39571/geode-core/src/main/java/org/apache/geode/admin/ConfigurationParameter.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/org/apache/geode/admin/ConfigurationParameter.java b/geode-core/src/main/java/org/apache/geode/admin/ConfigurationParameter.java index ff9b613..74e1510 100755 --- a/geode-core/src/main/java/org/apache/geode/admin/ConfigurationParameter.java +++ b/geode-core/src/main/java/org/apache/geode/admin/ConfigurationParameter.java @@ -1,72 +1,71 @@ /* - * 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; /** -* A single configuration parameter of a {@link SystemMember}. + * A single configuration parameter of a {@link SystemMember}. * - * @since GemFire 3.5 + * @since GemFire 3.5 * - * @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 ConfigurationParameter { - + /** Gets the identifying name of this configuration parameter. */ public String getName(); - + /** Gets the full description of this configuration parameter */ public String getDescription(); - + /** Gets the current value */ public Object getValue(); - + /** Gets the current value as a string */ public String getValueAsString(); - + /** Gets the class type of the value */ public Class getValueType(); - + /** True if this is modifiable; false if read-only */ public boolean isModifiable(); - + /** Returns true if this config parameter uses a string array for value. */ public boolean isArray(); - + /** Returns true if this config parameter represents an InetAddress value. */ public boolean isInetAddress(); - + /** Returns true if this config parameter represents a File value. */ public boolean isFile(); - + /** Returns true if this config parameter represents an octal value. */ public boolean isOctal(); - + /** Returns true if this config parameter represents a string value. */ public boolean isString(); - + /** * Sets a new value for this configuration parameter. * - * @param value the new value which must be of type {@link #getValueType} - * @throws IllegalArgumentException - * if value type does not match {@link #getValueType} - * @throws UnmodifiableConfigurationException - * if attempting to set value when isModifiable is false + * @param value the new value which must be of type {@link #getValueType} + * @throws IllegalArgumentException if value type does not match {@link #getValueType} + * @throws UnmodifiableConfigurationException if attempting to set value when isModifiable is + * false */ public void setValue(Object value) throws UnmodifiableConfigurationException; } http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8bf39571/geode-core/src/main/java/org/apache/geode/admin/DistributedSystemConfig.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/org/apache/geode/admin/DistributedSystemConfig.java b/geode-core/src/main/java/org/apache/geode/admin/DistributedSystemConfig.java index 67f8c7c..940d306 100755 --- a/geode-core/src/main/java/org/apache/geode/admin/DistributedSystemConfig.java +++ b/geode-core/src/main/java/org/apache/geode/admin/DistributedSystemConfig.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; @@ -25,53 +23,47 @@ import static org.apache.geode.distributed.ConfigurationProperties.*; /** - * Configuration for defining a GemFire distributed system to - * administrate. This configuration includes information about the - * discovery mechanism used to find members of the distributed system - * and information about {@linkplain ManagedEntity managed entities} - * such as {@linkplain DistributionLocator distribution locators} - * and {@linkplain CacheVm GemFire cache vms} - * that can be {@linkplain AdminDistributedSystem#start started}. + * Configuration for defining a GemFire distributed system to administrate. This configuration + * includes information about the discovery mechanism used to find members of the distributed system + * and information about {@linkplain ManagedEntity managed entities} such as + * {@linkplain DistributionLocator distribution locators} and {@linkplain CacheVm GemFire cache vms} + * that can be {@linkplain AdminDistributedSystem#start started}. * * <P> * - * Detailed descriptions of many of these configuration attributes can - * be found in the {@link - * org.apache.geode.distributed.DistributedSystem - * DistributedSystem} class. Note that the default values of these - * configuration attributes can be specified using Java system - * properties. + * Detailed descriptions of many of these configuration attributes can be found in the + * {@link org.apache.geode.distributed.DistributedSystem DistributedSystem} class. Note that the + * default values of these configuration attributes can be specified using Java system properties. * * <P> * - * A <code>DistributedSystemConfig</code> can be modified using a - * number of mutator methods until the - * <code>AdminDistributedSystem</code> that it configures {@linkplain - * AdminDistributedSystem#connect connects} to the distributed system. - * After that, attempts to modify most attributes in the - * <code>DistributedSystemConfig</code> will result in an {@link - * IllegalStateException} being thrown. If you wish to use the same - * <code>DistributedSystemConfig</code> to configure multiple - * <code>AdminDistributedSystem</code>s, a copy of the - * <code>DistributedSystemConfig</code> object can be made by invoking - * the {@link #clone} method. + * A <code>DistributedSystemConfig</code> can be modified using a number of mutator methods until + * the <code>AdminDistributedSystem</code> that it configures + * {@linkplain AdminDistributedSystem#connect connects} to the distributed system. After that, + * attempts to modify most attributes in the <code>DistributedSystemConfig</code> will result in an + * {@link IllegalStateException} being thrown. If you wish to use the same + * <code>DistributedSystemConfig</code> to configure multiple <code>AdminDistributedSystem</code>s, + * a copy of the <code>DistributedSystemConfig</code> object can be made by invoking the + * {@link #clone} method. * * @since GemFire 3.5 - * @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 DistributedSystemConfig extends Cloneable { - /** The name of an XML file that specifies the configuration for the - * {@linkplain ManagedEntity managed entities} administered by the - * <code>DistributedSystem</code>. The XML file must conform to a - * <a href="doc-files/ds5_0.dtd">dtd</a>. */ - String ENTITY_CONFIG_XML_FILE_NAME = - "entity-config-xml-file"; + /** + * The name of an XML file that specifies the configuration for the {@linkplain ManagedEntity + * managed entities} administered by the <code>DistributedSystem</code>. The XML file must conform + * to a <a href="doc-files/ds5_0.dtd">dtd</a>. + */ + String ENTITY_CONFIG_XML_FILE_NAME = "entity-config-xml-file"; - /** The default value of the "entity-config-xml-file" property - * ("distributed-system.xml"). */ - String DEFAULT_ENTITY_CONFIG_XML_FILE = - "distributed-system.xml"; + /** + * The default value of the "entity-config-xml-file" property ("distributed-system.xml"). + */ + String DEFAULT_ENTITY_CONFIG_XML_FILE = "distributed-system.xml"; /** The name of the "system-id" property */ String SYSTEM_ID_NAME = "system-id"; @@ -89,123 +81,128 @@ public interface DistributedSystemConfig extends Cloneable { String MCAST_PORT_NAME = MCAST_PORT; /** The default value of the "mcastPort" property (10334) */ - int DEFAULT_MCAST_PORT = - DistributionConfig.DEFAULT_MCAST_PORT; + int DEFAULT_MCAST_PORT = DistributionConfig.DEFAULT_MCAST_PORT; /** The minimum mcastPort (0) */ int MIN_MCAST_PORT = DistributionConfig.MIN_MCAST_PORT; /** The maximum mcastPort (65535) */ int MAX_MCAST_PORT = DistributionConfig.MAX_MCAST_PORT; - + /** The name of the "mcastAddress" property */ String MCAST_ADDRESS_NAME = MCAST_ADDRESS; /** The default value of the "mcastAddress" property (239.192.81.1). */ - String DEFAULT_MCAST_ADDRESS = - InetAddressUtil.toString(DistributionConfig.DEFAULT_MCAST_ADDRESS); - - /** The name of the "membership-port-range" property + String DEFAULT_MCAST_ADDRESS = InetAddressUtil.toString(DistributionConfig.DEFAULT_MCAST_ADDRESS); + + /** + * The name of the "membership-port-range" property + * * @since GemFire 6.5 */ String MEMBERSHIP_PORT_RANGE_NAME = MEMBERSHIP_PORT_RANGE; /** * The default membership-port-range. - * <p> Actual value is <code>[1024,65535]</code>. + * <p> + * Actual value is <code>[1024,65535]</code>. + * * @since GemFire 6.5 */ - int[] DEFAULT_MEMBERSHIP_PORT_RANGE = - DistributionConfig.DEFAULT_MEMBERSHIP_PORT_RANGE; - - /** settings for tcp-port + int[] DEFAULT_MEMBERSHIP_PORT_RANGE = DistributionConfig.DEFAULT_MEMBERSHIP_PORT_RANGE; + + /** + * settings for tcp-port + * * @since GemFire 6.5 */ String TCP_PORT_NAME = TCP_PORT; - /** The default value of the "tcpPort" property. - * <p> Actual value is <code>0</code>. + /** + * The default value of the "tcpPort" property. + * <p> + * Actual value is <code>0</code>. + * * @since GemFire 6.5 */ int DEFAULT_TCP_PORT = DistributionConfig.DEFAULT_TCP_PORT; /** * The default AckWaitThreshold. - * <p> Actual value of this constant is <code>15</code> seconds. + * <p> + * Actual value of this constant is <code>15</code> seconds. */ - int DEFAULT_ACK_WAIT_THRESHOLD = - DistributionConfig.DEFAULT_ACK_WAIT_THRESHOLD; + int DEFAULT_ACK_WAIT_THRESHOLD = DistributionConfig.DEFAULT_ACK_WAIT_THRESHOLD; /** * The minimum AckWaitThreshold. - * <p> Actual value of this constant is <code>1</code> second. + * <p> + * Actual value of this constant is <code>1</code> second. */ - int MIN_ACK_WAIT_THRESHOLD = - DistributionConfig.MIN_ACK_WAIT_THRESHOLD; + int MIN_ACK_WAIT_THRESHOLD = DistributionConfig.MIN_ACK_WAIT_THRESHOLD; /** * The maximum AckWaitThreshold. - * <p> Actual value of this constant is <code>MAX_INT</code> seconds. + * <p> + * Actual value of this constant is <code>MAX_INT</code> seconds. */ - int MAX_ACK_WAIT_THRESHOLD = - DistributionConfig.MIN_ACK_WAIT_THRESHOLD; - + int MAX_ACK_WAIT_THRESHOLD = DistributionConfig.MIN_ACK_WAIT_THRESHOLD; + /** * The default ackSevereAlertThreshold. - * <p> Actual value of this constant is <code>0</code> seconds, which - * turns off forced disconnects based on ack wait periods. + * <p> + * Actual value of this constant is <code>0</code> seconds, which turns off forced disconnects + * based on ack wait periods. */ - int DEFAULT_ACK_SEVERE_ALERT_THRESHOLD = - DistributionConfig.DEFAULT_ACK_SEVERE_ALERT_THRESHOLD; + int DEFAULT_ACK_SEVERE_ALERT_THRESHOLD = DistributionConfig.DEFAULT_ACK_SEVERE_ALERT_THRESHOLD; /** * The minimum ackSevereAlertThreshold. - * <p> Actual value of this constant is <code>0</code> second, - * which turns off forced disconnects based on ack wait periods. + * <p> + * Actual value of this constant is <code>0</code> second, which turns off forced disconnects + * based on ack wait periods. */ - int MIN_ACK_SEVERE_ALERT_THRESHOLD = - DistributionConfig.MIN_ACK_SEVERE_ALERT_THRESHOLD; + int MIN_ACK_SEVERE_ALERT_THRESHOLD = DistributionConfig.MIN_ACK_SEVERE_ALERT_THRESHOLD; /** * The maximum ackSevereAlertThreshold. - * <p> Actual value of this constant is <code>MAX_INT</code> seconds. + * <p> + * Actual value of this constant is <code>MAX_INT</code> seconds. */ - int MAX_ACK_SEVERE_ALERT_THRESHOLD = - DistributionConfig.MAX_ACK_SEVERE_ALERT_THRESHOLD; + int MAX_ACK_SEVERE_ALERT_THRESHOLD = DistributionConfig.MAX_ACK_SEVERE_ALERT_THRESHOLD; /** The name of the "locators" property (comma-delimited host[port] list) */ String LOCATORS_NAME = LOCATORS; /** The default value of the "locators" property ("") */ - String DEFAULT_LOCATORS = - DistributionConfig.DEFAULT_LOCATORS; + String DEFAULT_LOCATORS = DistributionConfig.DEFAULT_LOCATORS; /** The name of the "bindAddress" property */ String BIND_ADDRESS_NAME = BIND_ADDRESS; /** The default value of the "bindAddress" property */ - String DEFAULT_BIND_ADDRESS = - DistributionConfig.DEFAULT_BIND_ADDRESS; + String DEFAULT_BIND_ADDRESS = DistributionConfig.DEFAULT_BIND_ADDRESS; /** The name of the remote-command property */ String REMOTE_COMMAND_NAME = "remote-command"; /** The default value of the remote-command property */ - String DEFAULT_REMOTE_COMMAND = - "rsh -n {HOST} {CMD}"; + String DEFAULT_REMOTE_COMMAND = "rsh -n {HOST} {CMD}"; /** The default disable-tcp value (<code>false</code>) */ boolean DEFAULT_DISABLE_TCP = DistributionConfig.DEFAULT_DISABLE_TCP; - + /** The default enable-network-partition-detection setting (<code>false</code>) */ - boolean DEFAULT_ENABLE_NETWORK_PARTITION_DETECTION = DistributionConfig.DEFAULT_ENABLE_NETWORK_PARTITION_DETECTION; - + boolean DEFAULT_ENABLE_NETWORK_PARTITION_DETECTION = + DistributionConfig.DEFAULT_ENABLE_NETWORK_PARTITION_DETECTION; + /** The default disable-auto-reconnect setting (<code>false</code>) */ boolean DEFAULT_DISABLE_AUTO_RECONNECT = DistributionConfig.DEFAULT_DISABLE_AUTO_RECONNECT; /** The default failure-detection timeout period for member heart-beat responses */ int DEFAULT_MEMBER_TIMEOUT = DistributionConfig.DEFAULT_MEMBER_TIMEOUT; - + /** The name of the "logFile" property */ String LOG_FILE_NAME = LOG_FILE; - /** The default log-file value ("" which directs logging to standard - * output) */ + /** + * The default log-file value ("" which directs logging to standard output) + */ String DEFAULT_LOG_FILE = ""; /** The name of the "logLevel" property */ @@ -215,61 +212,51 @@ public interface DistributedSystemConfig extends Cloneable { String DEFAULT_LOG_LEVEL = "config"; /** The name of the "LogDiskSpaceLimit" property */ - String LOG_DISK_SPACE_LIMIT_NAME = - LOG_DISK_SPACE_LIMIT; + String LOG_DISK_SPACE_LIMIT_NAME = LOG_DISK_SPACE_LIMIT; /** The default log disk space limit in megabytes (0) */ - int DEFAULT_LOG_DISK_SPACE_LIMIT = - DistributionConfig.DEFAULT_LOG_DISK_SPACE_LIMIT; + int DEFAULT_LOG_DISK_SPACE_LIMIT = DistributionConfig.DEFAULT_LOG_DISK_SPACE_LIMIT; /** The minimum log disk space limit in megabytes (0) */ - int MIN_LOG_DISK_SPACE_LIMIT = - DistributionConfig.MIN_LOG_DISK_SPACE_LIMIT; + int MIN_LOG_DISK_SPACE_LIMIT = DistributionConfig.MIN_LOG_DISK_SPACE_LIMIT; /** The minimum log disk space limit in megabytes (1000000) */ - int MAX_LOG_DISK_SPACE_LIMIT = - DistributionConfig.MAX_LOG_DISK_SPACE_LIMIT; - + int MAX_LOG_DISK_SPACE_LIMIT = DistributionConfig.MAX_LOG_DISK_SPACE_LIMIT; + /** The name of the "LogFileSizeLimit" property */ String LOG_FILE_SIZE_LIMIT_NAME = LOG_FILE_SIZE_LIMIT; /** The default log file size limit in megabytes (0) */ - int DEFAULT_LOG_FILE_SIZE_LIMIT = - DistributionConfig.DEFAULT_LOG_FILE_SIZE_LIMIT; + int DEFAULT_LOG_FILE_SIZE_LIMIT = DistributionConfig.DEFAULT_LOG_FILE_SIZE_LIMIT; /** The minimum log file size limit in megabytes (0) */ - int MIN_LOG_FILE_SIZE_LIMIT = - DistributionConfig.MIN_LOG_FILE_SIZE_LIMIT; + int MIN_LOG_FILE_SIZE_LIMIT = DistributionConfig.MIN_LOG_FILE_SIZE_LIMIT; /** The minimum log file size limit in megabytes (1000000) */ - int MAX_LOG_FILE_SIZE_LIMIT = - DistributionConfig.MAX_LOG_FILE_SIZE_LIMIT; + int MAX_LOG_FILE_SIZE_LIMIT = DistributionConfig.MAX_LOG_FILE_SIZE_LIMIT; /** - * The name of the "refreshInterval" property which will apply to - * SystemMember, SystemMemberCache and StatisticResource refresh. This interval - * (in seconds) is used for auto-polling and updating AdminDistributedSystem - * constituents including SystemMember, CacheServer, SystemMemberCache and - * StatisticResource. This interval is read-only and retains the value set - * when the config is created. Note that the resource MBeans actually refresh - * and hit the DS only if there is an RMI client connected - * */ - String REFRESH_INTERVAL_NAME = - "refresh-interval"; + * The name of the "refreshInterval" property which will apply to SystemMember, SystemMemberCache + * and StatisticResource refresh. This interval (in seconds) is used for auto-polling and updating + * AdminDistributedSystem constituents including SystemMember, CacheServer, SystemMemberCache and + * StatisticResource. This interval is read-only and retains the value set when the config is + * created. Note that the resource MBeans actually refresh and hit the DS only if there is an RMI + * client connected + */ + String REFRESH_INTERVAL_NAME = "refresh-interval"; /** - * The default "refreshInterval" in seconds which will apply to - * REFRESH_INTERVAL_NAME property. The default value is 15 secs - * */ + * The default "refreshInterval" in seconds which will apply to REFRESH_INTERVAL_NAME property. + * The default value is 15 secs + */ int DEFAULT_REFRESH_INTERVAL = 15; - ////////////////////// Instance Methods ////////////////////// + ////////////////////// Instance Methods ////////////////////// /** - * Returns the name of the XML file that specifies the configuration - * of the {@linkplain org.apache.geode.admin.ManagedEntity - * managed entities} administered by the - * <code>DistributedSystem</code>. The XML file must conform to a + * Returns the name of the XML file that specifies the configuration of the + * {@linkplain org.apache.geode.admin.ManagedEntity managed entities} administered by the + * <code>DistributedSystem</code>. The XML file must conform to a * <a href="doc-files/ds5_0.dtd">dtd</a>. * * @since GemFire 4.0 @@ -277,9 +264,8 @@ public interface DistributedSystemConfig extends Cloneable { public String getEntityConfigXMLFile(); /** - * Sets the name of the XML file that specifies the configuration of - * managed entities administered by the - * <code>DistributedSystem</code>. + * Sets the name of the XML file that specifies the configuration of managed entities administered + * by the <code>DistributedSystem</code>. */ public void setEntityConfigXMLFile(String xmlFile); @@ -303,19 +289,19 @@ public interface DistributedSystemConfig extends Cloneable { /** Returns the multicast port for the system */ public int getMcastPort(); - + /** Sets the multicast port for the system */ public void setMcastPort(int mcastPort); /** Returns the ack-wait-threshold for the system */ public int getAckWaitThreshold(); - + /** Sets the ack-wait-threshold for the system */ public void setAckWaitThreshold(int seconds); /** Returns the ack-severe-alert-threshold for the system */ public int getAckSevereAlertThreshold(); - + /** Sets the ack-severe-alert-threshold for the system */ public void setAckSevereAlertThreshold(int seconds); @@ -326,43 +312,48 @@ public interface DistributedSystemConfig extends Cloneable { public void setLocators(String locators); /** - * Returns the membership-port-range property of the Distributed System. This - * range is given as two numbers separated by a minus sign. + * Returns the membership-port-range property of the Distributed System. This range is given as + * two numbers separated by a minus sign. + * * @since GemFire 6.5 */ public String getMembershipPortRange(); - + /** - * Sets the membership-port-range property of the Distributed System. This - * range is given as two numbers separated by a minus sign. + * Sets the membership-port-range property of the Distributed System. This range is given as two + * numbers separated by a minus sign. + * * @since GemFire 6.5 */ public void setMembershipPortRange(String membershipPortRange); - - + + /** * Sets the primary communication port number for the Distributed System. + * * @since GemFire 6.5 */ public void setTcpPort(int port); /** * Returns the primary communication port number for the Distributed System. + * * @since GemFire 6.5 */ public int getTcpPort(); - /** Sets the disable-tcp property for the system. When tcp is disabled, - the cache uses udp for unicast messaging. This must be consistent - across all members of the distributed system. The default is to enable - tcp. */ + /** + * Sets the disable-tcp property for the system. When tcp is disabled, the cache uses udp for + * unicast messaging. This must be consistent across all members of the distributed system. The + * default is to enable tcp. + */ public void setDisableTcp(boolean flag); - - /** Returns the disable-tcp property for the system. When tcp is - disabled, the cache uses udp for unicast messaging. This must be - consistent across all members of the distributed system. The default - is to enable tcp. + + /** + * Returns the disable-tcp property for the system. When tcp is disabled, the cache uses udp for + * unicast messaging. This must be consistent across all members of the distributed system. The + * default is to enable tcp. */ public boolean getDisableTcp(); @@ -371,74 +362,69 @@ public interface DistributedSystemConfig extends Cloneable { * Turns on network partition detection */ public void setEnableNetworkPartitionDetection(boolean newValue); + /** * Returns true if network partition detection is enabled. */ public boolean getEnableNetworkPartitionDetection(); - + /** * Disables auto reconnect after being forced out of the distributed system */ public void setDisableAutoReconnect(boolean newValue); - + /** * Returns true if auto reconnect is disabled */ public boolean getDisableAutoReconnect(); - - + + /** - * Returns the member-timeout millisecond value used in failure-detection - * protocols + * Returns the member-timeout millisecond value used in failure-detection protocols */ public int getMemberTimeout(); /** - * Set the millisecond value of the member-timeout used in failure-detection - * protocols. This timeout determines how long a member has to respond to - * a heartbeat request. The member is given three chances before being - * kicked out of the distributed system with a SystemConnectException. + * Set the millisecond value of the member-timeout used in failure-detection protocols. This + * timeout determines how long a member has to respond to a heartbeat request. The member is given + * three chances before being kicked out of the distributed system with a SystemConnectException. */ public void setMemberTimeout(int value); /** - * Returns the IP address to which the distributed system's server - * sockets are bound. + * Returns the IP address to which the distributed system's server sockets are bound. * * @since GemFire 4.0 */ public String getBindAddress(); /** - * Sets the IP address to which the distributed system's server - * sockets are bound. + * Sets the IP address to which the distributed system's server sockets are bound. * * @since GemFire 4.0 */ public void setBindAddress(String bindAddress); - - + + /** - * Returns the IP address to which client/server server sockets are - * bound + * Returns the IP address to which client/server server sockets are bound */ public String getServerBindAddress(); - + /** - * Sets the IP address to which a server cache will bind when listening - * for client cache connections. + * Sets the IP address to which a server cache will bind when listening for client cache + * connections. */ public void setServerBindAddress(String bindAddress); - + /** Returns the remote command setting to use for remote administration */ public String getRemoteCommand(); - /** - * Sets the remote command setting to use for remote administration. - * This attribute may be modified after this - * <code>DistributedSystemConfig</code> has been used to create an + /** + * Sets the remote command setting to use for remote administration. This attribute may be + * modified after this <code>DistributedSystemConfig</code> has been used to create an * <codE>AdminDistributedSystem</code>. */ public void setRemoteCommand(String command); @@ -466,7 +452,7 @@ public interface DistributedSystemConfig extends Cloneable { /** Sets the value of the "ssl-require-authentication" property. */ public void setSSLAuthenticationRequired(boolean authRequired); - + /** Returns the provider-specific properties for SSL. */ public Properties getSSLProperties(); @@ -478,18 +464,16 @@ public interface DistributedSystemConfig extends Cloneable { /** Removes an SSL property */ public void removeSSLProperty(String key); - + /** - * Returns the name of the log file to which informational messages - * are written. + * Returns the name of the log file to which informational messages are written. * * @see org.apache.geode.i18n.LogWriterI18n */ public String getLogFile(); /** - * Sets the name of the log file to which informational messages - * are written. + * Sets the name of the log file to which informational messages are written. * * @see org.apache.geode.i18n.LogWriterI18n */ @@ -527,76 +511,79 @@ public interface DistributedSystemConfig extends Cloneable { /** * Returns the refreshInterval in seconds used for auto-polling and updating - * AdminDistributedSystem constituents including SystemMember, CacheServer, - * SystemMemberCache and StatisticResource + * AdminDistributedSystem constituents including SystemMember, CacheServer, SystemMemberCache and + * StatisticResource + * * @since GemFire 6.0 */ public int getRefreshInterval(); /** * Sets the refreshInterval in seconds + * * @since GemFire 6.0 */ public void setRefreshInterval(int timeInSecs); - /** - * Returns an array of configurations for statically known - * <code>CacheServers</code>. + /** + * Returns an array of configurations for statically known <code>CacheServers</code>. + * * @deprecated as of 5.7 use {@link #getCacheVmConfigs} instead. - */ + */ @Deprecated public CacheServerConfig[] getCacheServerConfigs(); - /** + /** * Creates the configuration for a CacheServer + * * @deprecated as of 5.7 use {@link #createCacheVmConfig} instead. */ @Deprecated public CacheServerConfig createCacheServerConfig(); - /** + /** * Removes the configuration for a CacheServer + * * @deprecated as of 5.7 use {@link #removeCacheVmConfig} instead. */ @Deprecated public void removeCacheServerConfig(CacheServerConfig managerConfig); - /** - * Returns an array of configurations for statically known - * {@link CacheVm}s. + /** + * Returns an array of configurations for statically known {@link CacheVm}s. + * * @since GemFire 5.7 - */ + */ public CacheVmConfig[] getCacheVmConfigs(); - /** + /** * Creates the configuration for a {@link CacheVm}. + * * @since GemFire 5.7 */ public CacheVmConfig createCacheVmConfig(); - /** + /** * Removes the configuration for a {@link CacheVm} + * * @since GemFire 5.7 */ public void removeCacheVmConfig(CacheVmConfig existing); /** - * Returns configuration information about {@link - * DistributionLocator}s that are managed by an + * Returns configuration information about {@link DistributionLocator}s that are managed by an * <code>AdminDistributedSystem</code>. */ public DistributionLocatorConfig[] getDistributionLocatorConfigs(); - + /** - * Creates a new <code>DistributionLocatorConfig</code> for a - * distribution locator that is managed in this distributed system. - * The default locator config is set to not use multicast + * Creates a new <code>DistributionLocatorConfig</code> for a distribution locator that is managed + * in this distributed system. The default locator config is set to not use multicast */ public DistributionLocatorConfig createDistributionLocatorConfig(); /** - * Removes a <code>DistributionLocatorConfig</code> from the - * distributed system. + * Removes a <code>DistributionLocatorConfig</code> from the distributed system. */ public void removeDistributionLocatorConfig(DistributionLocatorConfig config); @@ -607,31 +594,28 @@ public interface DistributedSystemConfig extends Cloneable { public void removeListener(ConfigListener listener); /** - * Validates that this distributed system configuration is correct - * and consistent. + * Validates that this distributed system configuration is correct and consistent. * - * @throws IllegalStateException - * If this config is not valid - * @throws AdminXmlException - * If the {@linkplain #getEntityConfigXMLFile entity config - * XML file} is not valid + * @throws IllegalStateException If this config is not valid + * @throws AdminXmlException If the {@linkplain #getEntityConfigXMLFile entity config XML file} is + * not valid */ public void validate(); /** - * Returns a copy of this <code>DistributedSystemConfig</code> - * object whose configuration can be modified. Note that this - * {@link DistributedSystemConfig.ConfigListener ConfigListener}s - * that are registered on this config object are not cloned. + * Returns a copy of this <code>DistributedSystemConfig</code> object whose configuration can be + * modified. Note that this {@link DistributedSystemConfig.ConfigListener ConfigListener}s that + * are registered on this config object are not cloned. * * @since GemFire 4.0 */ public Object clone() throws CloneNotSupportedException; - ////////////////////// Inner Classes ////////////////////// + ////////////////////// Inner Classes ////////////////////// - /** A listener whose callback methods are invoked when this config - * changes. */ + /** + * A listener whose callback methods are invoked when this config changes. + */ public interface ConfigListener extends java.util.EventListener { /** Invoked when this configurated is changed. */ http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8bf39571/geode-core/src/main/java/org/apache/geode/admin/DistributedSystemHealthConfig.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/org/apache/geode/admin/DistributedSystemHealthConfig.java b/geode-core/src/main/java/org/apache/geode/admin/DistributedSystemHealthConfig.java index d9416ce..d7f7751 100644 --- a/geode-core/src/main/java/org/apache/geode/admin/DistributedSystemHealthConfig.java +++ b/geode-core/src/main/java/org/apache/geode/admin/DistributedSystemHealthConfig.java @@ -1,74 +1,72 @@ /* - * 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; /** - * Provides configuration information relating to the health of an - * entire GemFire distributed system. + * Provides configuration information relating to the health of an entire GemFire distributed + * system. * * <P> * - * If any of the following criteria is - * true, then the distributed system is considered to be in + * If any of the following criteria is true, then the distributed system is considered to be in * {@link GemFireHealth#OKAY_HEALTH OKAY_HEALTH}. * * <UL> * * </UL> * - * If any of the following criteria is true, then the distributed - * system is considered to be in {@link GemFireHealth#POOR_HEALTH - * POOR_HEALTH}. + * If any of the following criteria is true, then the distributed system is considered to be in + * {@link GemFireHealth#POOR_HEALTH POOR_HEALTH}. * * <UL> * - * <LI>Too many application members {@linkplain - * #getMaxDepartedApplications unexpectedly leave} the distributed - * system.</LI> + * <LI>Too many application members {@linkplain #getMaxDepartedApplications unexpectedly leave} the + * distributed system.</LI> * - * <LI>Too many application members {@linkplain - * #getMaxDepartedApplications unexpectedly leave} the distributed - * system.</LI> + * <LI>Too many application members {@linkplain #getMaxDepartedApplications unexpectedly leave} the + * distributed system.</LI> * * </UL> * * * @since GemFire 3.5 - * @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 DistributedSystemHealthConfig { - /** The default maximum number of application members that can - * unexceptedly leave a healthy the distributed system. */ + /** + * The default maximum number of application members that can unexceptedly leave a healthy the + * distributed system. + */ public static final long DEFAULT_MAX_DEPARTED_APPLICATIONS = 10; - /////////////////////// Instance Methods /////////////////////// + /////////////////////// Instance Methods /////////////////////// /** - * Returns the maximum number of application members that can - * unexceptedly leave a healthy the distributed system. + * Returns the maximum number of application members that can unexceptedly leave a healthy the + * distributed system. * * @see #DEFAULT_MAX_DEPARTED_APPLICATIONS */ public long getMaxDepartedApplications(); /** - * Sets the maximum number of application members that can - * unexceptedly leave a healthy the distributed system. + * Sets the maximum number of application members that can unexceptedly leave a healthy the + * distributed system. * * @see #getMaxDepartedApplications */ http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8bf39571/geode-core/src/main/java/org/apache/geode/admin/DistributionLocator.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/org/apache/geode/admin/DistributionLocator.java b/geode-core/src/main/java/org/apache/geode/admin/DistributionLocator.java index da8864c..cb82679 100755 --- a/geode-core/src/main/java/org/apache/geode/admin/DistributionLocator.java +++ b/geode-core/src/main/java/org/apache/geode/admin/DistributionLocator.java @@ -1,40 +1,39 @@ /* - * 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; /** - * Represents a single distribution locator server, of which a - * distributed system may use zero or many. The distributed system - * will be configured to use either multicast discovery or locator + * Represents a single distribution locator server, of which a distributed system may use zero or + * many. The distributed system will be configured to use either multicast discovery or locator * service. * * @see DistributionLocatorConfig * * @since GemFire 3.5 - * @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 DistributionLocator extends ManagedEntity { - - /** + + /** * Returns the identity name for this locator. */ public String getId(); - + /** * Returns the configuration object for this distribution locator. * http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8bf39571/geode-core/src/main/java/org/apache/geode/admin/DistributionLocatorConfig.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/org/apache/geode/admin/DistributionLocatorConfig.java b/geode-core/src/main/java/org/apache/geode/admin/DistributionLocatorConfig.java index 162f4f1..6e8794d 100644 --- a/geode-core/src/main/java/org/apache/geode/admin/DistributionLocatorConfig.java +++ b/geode-core/src/main/java/org/apache/geode/admin/DistributionLocatorConfig.java @@ -1,86 +1,78 @@ /* - * 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; + import java.util.Properties; /** - * Describes the configuration of a {@link DistributionLocator} - * managed by the GemFire administration APIs. + * Describes the configuration of a {@link DistributionLocator} managed by the GemFire + * administration APIs. * * <P> * - * A <code>DistributionLocatorConfig</code> can be modified using a - * number of mutator methods until the - * <code>DistributionLocator</code> configured by this object is - * {@linkplain ManagedEntity#start started}. After that, - * attempts to modify most attributes in the - * <code>DistributionLocatorConfig</code> will result in an {@link - * IllegalStateException} being thrown. If you wish to use the same - * <code>DistributionLocatorConfig</code> to configure another - * <code>DistributionLocator</code>s, a copy of the - * <code>DistributionLocatorConfig</code> object can be made by - * invoking the {@link Object#clone} method. + * A <code>DistributionLocatorConfig</code> can be modified using a number of mutator methods until + * the <code>DistributionLocator</code> configured by this object is {@linkplain ManagedEntity#start + * started}. After that, attempts to modify most attributes in the + * <code>DistributionLocatorConfig</code> will result in an {@link IllegalStateException} being + * thrown. If you wish to use the same <code>DistributionLocatorConfig</code> to configure another + * <code>DistributionLocator</code>s, a copy of the <code>DistributionLocatorConfig</code> object + * can be made by invoking the {@link Object#clone} method. * * @see AdminDistributedSystem#addDistributionLocator * @see org.apache.geode.distributed.Locator * * @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 DistributionLocatorConfig - extends ManagedEntityConfig { +public interface DistributionLocatorConfig extends ManagedEntityConfig { /** - * Returns the port on which ths distribution locator listens for - * members to connect. There is no default locator port, so a - * non-default port must be specified. + * Returns the port on which ths distribution locator listens for members to connect. There is no + * default locator port, so a non-default port must be specified. */ public int getPort(); /** - * Sets the port on which the distribution locator listens for - * members to connect. + * Sets the port on which the distribution locator listens for members to connect. */ public void setPort(int port); /** - * Returns the address to which the distribution locator's port is - * (or will be) bound. By default, the bind address is - * <code>null</code> meaning that the port will be bound to all - * network addresses on the host. + * Returns the address to which the distribution locator's port is (or will be) bound. By default, + * the bind address is <code>null</code> meaning that the port will be bound to all network + * addresses on the host. */ public String getBindAddress(); /** - * Sets the address to which the distribution locator's port is - * (or will be) bound. + * Sets the address to which the distribution locator's port is (or will be) bound. */ public void setBindAddress(String bindAddress); /** - * Sets the properties used to configure the locator's - * DistributedSystem. + * Sets the properties used to configure the locator's DistributedSystem. + * * @since GemFire 5.0 */ public void setDistributedSystemProperties(Properties props); - + /** - * Retrieves the properties used to configure the locator's - * DistributedSystem. + * Retrieves the properties used to configure the locator's DistributedSystem. + * * @since GemFire 5.0 */ public Properties getDistributedSystemProperties(); http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8bf39571/geode-core/src/main/java/org/apache/geode/admin/GemFireHealth.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/org/apache/geode/admin/GemFireHealth.java b/geode-core/src/main/java/org/apache/geode/admin/GemFireHealth.java index 202ce70..bb8590a 100644 --- a/geode-core/src/main/java/org/apache/geode/admin/GemFireHealth.java +++ b/geode-core/src/main/java/org/apache/geode/admin/GemFireHealth.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; @@ -20,59 +18,56 @@ import org.apache.geode.internal.Assert; import org.apache.geode.internal.i18n.LocalizedStrings; /** - * Provides information about the aggregate health of the members of a - * GemFire distributed system ("components"). The {@link #getHealth - * getHealth} method provides an indication of the overall health. - * Health is expressed as one of three levels: {@link #GOOD_HEALTH - * GOOD_HEALTH}, {@link #OKAY_HEALTH OKAY_HEALTH}, and {@link - * #POOR_HEALTH POOR_HEALTH}. The {@link #getDiagnosis getDiagnosis} - * method provides a more detailed explanation of the cause of ill - * health. + * Provides information about the aggregate health of the members of a GemFire distributed system + * ("components"). The {@link #getHealth getHealth} method provides an indication of the overall + * health. Health is expressed as one of three levels: {@link #GOOD_HEALTH GOOD_HEALTH}, + * {@link #OKAY_HEALTH OKAY_HEALTH}, and {@link #POOR_HEALTH POOR_HEALTH}. The {@link #getDiagnosis + * getDiagnosis} method provides a more detailed explanation of the cause of ill health. * * <P> * * The aggregate health of the GemFire component is evaluated - * {@linkplain GemFireHealthConfig#setHealthEvaluationInterval every - * so often} and if certain criteria are met, then the overall health - * of the component changes accordingly. If any of the components is - * in <code>OKAY_HEALTH</code>, then the overall health is - * <code>OKAY_HEALTH</code>. If any of the components is in - * <code>POOR_HEALTH</code>, then the overall health is + * {@linkplain GemFireHealthConfig#setHealthEvaluationInterval every so often} and if certain + * criteria are met, then the overall health of the component changes accordingly. If any of the + * components is in <code>OKAY_HEALTH</code>, then the overall health is <code>OKAY_HEALTH</code>. + * If any of the components is in <code>POOR_HEALTH</code>, then the overall health is * <code>POOR_HEALTH</code>. * * * @since GemFire 3.5 - * @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 GemFireHealth { - /** An indicator that the GemFire components are healthy. + /** + * An indicator that the GemFire components are healthy. * - * @see #getHealth */ - public static final Health GOOD_HEALTH = - new Health(Health.GOOD_STRING); + * @see #getHealth + */ + public static final Health GOOD_HEALTH = new Health(Health.GOOD_STRING); - /** An indicator that one or more GemFire components is slightly - * unhealthy. The problem may or may not require configuration - * changes and may not necessarily lead to poorer component health. + /** + * An indicator that one or more GemFire components is slightly unhealthy. The problem may or may + * not require configuration changes and may not necessarily lead to poorer component health. * - * @see #getHealth */ - public static final Health OKAY_HEALTH = - new Health(Health.OKAY_STRING); + * @see #getHealth + */ + public static final Health OKAY_HEALTH = new Health(Health.OKAY_STRING); - /** An indicator that one or more GemFire components is unhealthy. - * While it may be possible for the components to recover on their - * own, it is likely that they will have to be restarted. + /** + * An indicator that one or more GemFire components is unhealthy. While it may be possible for the + * components to recover on their own, it is likely that they will have to be restarted. * - * @see #getHealth */ - public static final Health POOR_HEALTH = - new Health(Health.POOR_STRING); + * @see #getHealth + */ + public static final Health POOR_HEALTH = new Health(Health.POOR_STRING); - /////////////////////// Instance Methods /////////////////////// + /////////////////////// Instance Methods /////////////////////// /** - * Returns an indicator of the overall health of the GemFire - * components. + * Returns an indicator of the overall health of the GemFire components. * * @see #GOOD_HEALTH * @see #OKAY_HEALTH @@ -80,97 +75,80 @@ public interface GemFireHealth { */ public Health getHealth(); - /** - * Resets the overall health of the GemFire components to {@link - * #GOOD_HEALTH}. This operation should be invoked when the - * operator has determined that warnings about the components's - * health do not need to be regarded. + /** + * Resets the overall health of the GemFire components to {@link #GOOD_HEALTH}. This operation + * should be invoked when the operator has determined that warnings about the components's health + * do not need to be regarded. */ public void resetHealth(); /** - * Returns a message that provides a description of the cause of a - * component's ill health. + * Returns a message that provides a description of the cause of a component's ill health. */ public String getDiagnosis(); /** - * Returns the configuration for determining the health of the - * distributed system itself. + * Returns the configuration for determining the health of the distributed system itself. */ public DistributedSystemHealthConfig getDistributedSystemHealthConfig(); /** - * Sets the configuration for determining the health of the - * distributed system itself. + * Sets the configuration for determining the health of the distributed system itself. */ public void setDistributedSystemHealthConfig(DistributedSystemHealthConfig config); /** - * Returns the <code>GemFireHealthConfig</code> for GemFire - * components whose configurations are not overridden on a per-host - * basis. Note that changes made to the returned + * Returns the <code>GemFireHealthConfig</code> for GemFire components whose configurations are + * not overridden on a per-host basis. Note that changes made to the returned * <code>GemFireHealthConfig</code> will not take effect until * {@link #setDefaultGemFireHealthConfig} is invoked. */ public GemFireHealthConfig getDefaultGemFireHealthConfig(); /** - * Sets the <code>GemFireHealthConfig</code> for - * GemFire components whose configurations are not overridden on a - * per-host basis. + * Sets the <code>GemFireHealthConfig</code> for GemFire components whose configurations are not + * overridden on a per-host basis. * - * @throws IllegalArgumentException - * If <code>config</code> specifies the config for a host + * @throws IllegalArgumentException If <code>config</code> specifies the config for a host */ public void setDefaultGemFireHealthConfig(GemFireHealthConfig config); /** - * Returns the <code>GemFireHealthConfig</code> for GemFire - * components that reside on a given host. This configuration will - * override the {@linkplain #getDefaultGemFireHealthConfig default} + * Returns the <code>GemFireHealthConfig</code> for GemFire components that reside on a given + * host. This configuration will override the {@linkplain #getDefaultGemFireHealthConfig default} * configuration. * - * @param hostName - * The {@linkplain java.net.InetAddress#getCanonicalHostName - * canonical} name of the host. + * @param hostName The {@linkplain java.net.InetAddress#getCanonicalHostName canonical} name of + * the host. */ public GemFireHealthConfig getGemFireHealthConfig(String hostName); /** - * Sets the <code>GemFireHealthConfig</code> for GemFire - * components that reside on a given host. This configuration will - * override the {@linkplain #getDefaultGemFireHealthConfig default} - * configuration. Note that changes made to the returned - * <code>GemFireHealthConfig</code> will not take effect until - * {@link #setDefaultGemFireHealthConfig} is invoked. + * Sets the <code>GemFireHealthConfig</code> for GemFire components that reside on a given host. + * This configuration will override the {@linkplain #getDefaultGemFireHealthConfig default} + * configuration. Note that changes made to the returned <code>GemFireHealthConfig</code> will not + * take effect until {@link #setDefaultGemFireHealthConfig} is invoked. * - * @param hostName - * The {@linkplain java.net.InetAddress#getCanonicalHostName - * canonical} name of the host. + * @param hostName The {@linkplain java.net.InetAddress#getCanonicalHostName canonical} name of + * the host. * - * @throws IllegalArgumentException - * If host <code>hostName</code> does not exist or if there - * are no GemFire components running on that host or if - * <code>config</code> does not configure host - * <code>hostName</code>. + * @throws IllegalArgumentException If host <code>hostName</code> does not exist or if there are + * no GemFire components running on that host or if <code>config</code> does not configure + * host <code>hostName</code>. */ - public void setGemFireHealthConfig(String hostName, - GemFireHealthConfig config); + public void setGemFireHealthConfig(String hostName, GemFireHealthConfig config); /** - * Closes this health monitor and releases all resources associated - * with it. + * Closes this health monitor and releases all resources associated with it. */ public void close(); /** - * Returns whether or not this <code>GemFireHealth</code> is - * {@linkplain #close closed}. + * Returns whether or not this <code>GemFireHealth</code> is {@linkplain #close closed}. */ public boolean isClosed(); - ////////////////////// Inner Classes ////////////////////// + ////////////////////// Inner Classes ////////////////////// /** * An enumerated type for the health of GemFire. @@ -186,12 +164,12 @@ public interface GemFireHealth { /** The string for poor health */ static final String POOR_STRING = LocalizedStrings.GemFireHealth_POOR.toLocalizedString(); - //////////////////// Instance Fields //////////////////// + //////////////////// Instance Fields //////////////////// /** The string for this health */ private String healthString; - ///////////////////// Constructors ////////////////////// + ///////////////////// Constructors ////////////////////// /** * Creates a new <code>Health</code> with the given string @@ -199,12 +177,11 @@ public interface GemFireHealth { protected Health(String healthString) { this.healthString = healthString; } - - //////////////////// Instance Methods //////////////////// + + //////////////////// Instance Methods //////////////////// /** - * Returns the appropriate canonical instance of - * <code>Health</code>. + * Returns the appropriate canonical instance of <code>Health</code>. */ public Object readResolve() { if (this.healthString.equals(GOOD_STRING)) { @@ -217,8 +194,7 @@ public interface GemFireHealth { return GemFireHealth.POOR_HEALTH; } else { - Assert.assertTrue(false, "Unknown healthString: " + - this.healthString); + Assert.assertTrue(false, "Unknown healthString: " + this.healthString); return null; } } http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8bf39571/geode-core/src/main/java/org/apache/geode/admin/GemFireHealthConfig.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/org/apache/geode/admin/GemFireHealthConfig.java b/geode-core/src/main/java/org/apache/geode/admin/GemFireHealthConfig.java index 638244a..b31861f 100644 --- a/geode-core/src/main/java/org/apache/geode/admin/GemFireHealthConfig.java +++ b/geode-core/src/main/java/org/apache/geode/admin/GemFireHealthConfig.java @@ -1,56 +1,53 @@ /* - * 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; /** - * Provides configuration information relating to all of the - * components of a GemFire distributed system. + * Provides configuration information relating to all of the components of a GemFire distributed + * system. * * * @since GemFire 3.5 - * @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 GemFireHealthConfig - extends MemberHealthConfig, CacheHealthConfig { + * @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 GemFireHealthConfig extends MemberHealthConfig, CacheHealthConfig { - /** The default number of seconds between assessments of the health - * of the GemFire components. */ + /** + * The default number of seconds between assessments of the health of the GemFire components. + */ public static final int DEFAULT_HEALTH_EVALUATION_INTERVAL = 30; - ////////////////////// Instance Methods ////////////////////// + ////////////////////// Instance Methods ////////////////////// /** - * Returns the name of the host to which this configuration - * applies. If this is the "default" configuration, then - * <code>null</code> is returned. + * Returns the name of the host to which this configuration applies. If this is the "default" + * configuration, then <code>null</code> is returned. * * @see GemFireHealth#getGemFireHealthConfig */ public String getHostName(); /** - * Sets the number of seconds between assessments of the health of - * the GemFire components. + * Sets the number of seconds between assessments of the health of the GemFire components. */ public void setHealthEvaluationInterval(int interval); /** - * Returns the number of seconds between assessments of the health of - * the GemFire components. + * Returns the number of seconds between assessments of the health of the GemFire components. */ public int getHealthEvaluationInterval();