http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8bf39571/geode-core/src/main/java/org/apache/geode/admin/SystemMemberBridgeServer.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/org/apache/geode/admin/SystemMemberBridgeServer.java b/geode-core/src/main/java/org/apache/geode/admin/SystemMemberBridgeServer.java index 71fb7e1..7a1fb1a 100644 --- a/geode-core/src/main/java/org/apache/geode/admin/SystemMemberBridgeServer.java +++ b/geode-core/src/main/java/org/apache/geode/admin/SystemMemberBridgeServer.java @@ -1,26 +1,24 @@ /* - * 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 org.apache.geode.cache.server.ServerLoadProbe; /** - * Administrative interface that represents a CacheServer that - * serves the contents of a system member's cache. + * Administrative interface that represents a CacheServer that serves the contents of a system + * member's cache. * * @see SystemMemberCache#addCacheServer * @@ -30,39 +28,33 @@ import org.apache.geode.cache.server.ServerLoadProbe; @Deprecated public interface SystemMemberBridgeServer { - /** - * Returns the port on which this bridge server listens for bridge - * clients to connect. + /** + * Returns the port on which this bridge server listens for bridge clients to connect. */ public int getPort(); /** - * Sets the port on which this bridge server listens for bridge - * clients to connect. + * Sets the port on which this bridge server listens for bridge clients to connect. * - * @throws AdminException - * If this bridge server is running + * @throws AdminException If this bridge server is running */ public void setPort(int port) throws AdminException; /** - * Starts this bridge server. Once the server is running, its - * configuration cannot be changed. + * Starts this bridge server. Once the server is running, its configuration cannot be changed. * - * @throws AdminException - * If an error occurs while starting the bridge server + * @throws AdminException If an error occurs while starting the bridge server */ public void start() throws AdminException; - /** + /** * Returns whether or not this bridge server is running */ public boolean isRunning(); /** - * Stops this bridge server. Note that the - * <code>BridgeServer</code> can be reconfigured and restarted if - * desired. + * Stops this bridge server. Note that the <code>BridgeServer</code> can be reconfigured and + * restarted if desired. */ public void stop() throws AdminException; @@ -72,80 +64,87 @@ public interface SystemMemberBridgeServer { public void refresh(); /** - * Returns a string representing the ip address or host name that this server - * will listen on. + * Returns a string representing the ip address or host name that this server will listen on. + * * @return the ip address or host name that this server is to listen on * @since GemFire 5.7 */ public String getBindAddress(); + /** - * Sets the ip address or host name that this server is to listen on for - * client connections. - * <p>Setting a specific bind address will cause the bridge server to always - * use this address and ignore any address specified by "server-bind-address" - * or "bind-address" in the <code>gemfire.properties</code> file - * (see {@link org.apache.geode.distributed.DistributedSystem} - * for a description of these properties). - * <p> A <code>null</code> value will be treated the same as the default "". - * <p> The default value does not override the gemfire.properties. If you wish to - * override the properties and want to have your server bind to all local - * addresses then use this string <code>"0.0.0.0"</code>. + * Sets the ip address or host name that this server is to listen on for client connections. + * <p> + * Setting a specific bind address will cause the bridge server to always use this address and + * ignore any address specified by "server-bind-address" or "bind-address" in the + * <code>gemfire.properties</code> file (see + * {@link org.apache.geode.distributed.DistributedSystem} for a description of these properties). + * <p> + * A <code>null</code> value will be treated the same as the default "". + * <p> + * The default value does not override the gemfire.properties. If you wish to override the + * properties and want to have your server bind to all local addresses then use this string + * <code>"0.0.0.0"</code>. + * * @param address the ip address or host name that this server is to listen on * @throws AdminException if this bridge server is running * @since GemFire 5.7 */ public void setBindAddress(String address) throws AdminException; + /** - * Returns a string representing the ip address or host name that server locators - * will tell clients that this server is listening on. - * @return the ip address or host name to give to clients so they can connect - * to this server + * Returns a string representing the ip address or host name that server locators will tell + * clients that this server is listening on. + * + * @return the ip address or host name to give to clients so they can connect to this server * @since GemFire 5.7 */ public String getHostnameForClients(); + /** - * Sets the ip address or host name that this server is to listen on for - * client connections. - * <p>Setting a specific hostname-for-clients will cause server locators - * to use this value when telling clients how to connect to this server. - * <p> The default value causes the bind-address to be given to clients - * <p> A <code>null</code> value will be treated the same as the default "". - * @param name the ip address or host name that will be given to clients - * so they can connect to this server + * Sets the ip address or host name that this server is to listen on for client connections. + * <p> + * Setting a specific hostname-for-clients will cause server locators to use this value when + * telling clients how to connect to this server. + * <p> + * The default value causes the bind-address to be given to clients + * <p> + * A <code>null</code> value will be treated the same as the default "". + * + * @param name the ip address or host name that will be given to clients so they can connect to + * this server * @throws AdminException if this bridge server is running * @since GemFire 5.7 */ public void setHostnameForClients(String name) throws AdminException; + /** - * Sets whether or not this bridge server should notify clients based on - * key subscription. + * Sets whether or not this bridge server should notify clients based on key subscription. * - * If false, then an update to any key on the server causes an update to - * be sent to all clients. This update does not push the actual data to the - * clients. Instead, it causes the client to locally invalidate or destroy - * the corresponding entry. The next time the client requests the key, it - * goes to the bridge server for the value. + * If false, then an update to any key on the server causes an update to be sent to all clients. + * This update does not push the actual data to the clients. Instead, it causes the client to + * locally invalidate or destroy the corresponding entry. The next time the client requests the + * key, it goes to the bridge server for the value. * - * If true, then an update to any key on the server causes an update to be - * sent to only those clients who have registered interest in that key. Other - * clients are not notified of the change. In addition, the actual value is - * pushed to the client. The client does not need to request the new value - * from the bridge server. + * If true, then an update to any key on the server causes an update to be sent to only those + * clients who have registered interest in that key. Other clients are not notified of the change. + * In addition, the actual value is pushed to the client. The client does not need to request the + * new value from the bridge server. + * * @throws AdminException if this bridge server is running * @since GemFire 5.7 */ public void setNotifyBySubscription(boolean b) throws AdminException; /** - * Answers whether or not this bridge server should notify clients based on - * key subscription. + * Answers whether or not this bridge server should notify clients based on key subscription. + * * @since GemFire 5.7 */ public boolean getNotifyBySubscription(); /** - * Sets the buffer size in bytes of the socket connection for this - * <code>BridgeServer</code>. The default is 32768 bytes. + * Sets the buffer size in bytes of the socket connection for this <code>BridgeServer</code>. The + * default is 32768 bytes. * * @param socketBufferSize The size in bytes of the socket buffer * @throws AdminException if this bridge server is running @@ -154,155 +153,155 @@ public interface SystemMemberBridgeServer { public void setSocketBufferSize(int socketBufferSize) throws AdminException; /** - * Returns the configured buffer size of the socket connection for this - * <code>BridgeServer</code>. The default is 32768 bytes. - * @return the configured buffer size of the socket connection for this - * <code>BridgeServer</code> + * Returns the configured buffer size of the socket connection for this <code>BridgeServer</code>. + * The default is 32768 bytes. + * + * @return the configured buffer size of the socket connection for this <code>BridgeServer</code> * @since GemFire 5.7 */ public int getSocketBufferSize(); /** - * Sets the maximum amount of time between client pings. This value is - * used by the <code>ClientHealthMonitor</code> to determine the health - * of this <code>BridgeServer</code>'s clients. The default is 60000 ms. + * Sets the maximum amount of time between client pings. This value is used by the + * <code>ClientHealthMonitor</code> to determine the health of this <code>BridgeServer</code>'s + * clients. The default is 60000 ms. * - * @param maximumTimeBetweenPings The maximum amount of time between client - * pings + * @param maximumTimeBetweenPings The maximum amount of time between client pings * @throws AdminException if this bridge server is running * @since GemFire 5.7 */ public void setMaximumTimeBetweenPings(int maximumTimeBetweenPings) throws AdminException; /** - * Returns the maximum amount of time between client pings. This value is - * used by the <code>ClientHealthMonitor</code> to determine the health - * of this <code>BridgeServer</code>'s clients. The default is 60000 ms. + * Returns the maximum amount of time between client pings. This value is used by the + * <code>ClientHealthMonitor</code> to determine the health of this <code>BridgeServer</code>'s + * clients. The default is 60000 ms. + * * @return the maximum amount of time between client pings. * @since GemFire 5.7 */ public int getMaximumTimeBetweenPings(); - /** - * Returns the maximum allowed client connections + /** + * Returns the maximum allowed client connections + * * @since GemFire 5.7 */ public int getMaxConnections(); /** - * Sets the maxium number of client connections allowed. - * When the maximum is reached the server will stop accepting - * connections. + * Sets the maxium number of client connections allowed. When the maximum is reached the server + * will stop accepting connections. + * * @throws AdminException if this bridge server is running * @since GemFire 5.7 */ public void setMaxConnections(int maxCons) throws AdminException; - /** - * Returns the maxium number of threads allowed in this server to service - * client requests. - * The default of <code>0</code> causes the server to dedicate a thread for - * every client connection. + /** + * Returns the maxium number of threads allowed in this server to service client requests. The + * default of <code>0</code> causes the server to dedicate a thread for every client connection. + * * @since GemFire 5.7 */ public int getMaxThreads(); /** - * Sets the maxium number of threads allowed in this server to service - * client requests. - * The default of <code>0</code> causes the server to dedicate a thread for - * every client connection. + * Sets the maxium number of threads allowed in this server to service client requests. The + * default of <code>0</code> causes the server to dedicate a thread for every client connection. + * * @throws AdminException if this bridge server is running * @since GemFire 5.7 */ public void setMaxThreads(int maxThreads) throws AdminException; /** - * Returns the maximum number of messages that can be enqueued in a - * client-queue. + * Returns the maximum number of messages that can be enqueued in a client-queue. + * * @since GemFire 5.7 */ public int getMaximumMessageCount(); /** * Sets maximum number of messages that can be enqueued in a client-queue. + * * @throws AdminException if this bridge server is running * @since GemFire 5.7 */ public void setMaximumMessageCount(int maxMessageCount) throws AdminException; - + /** - * Returns the time (in seconds ) after which a message in the client queue - * will expire. + * Returns the time (in seconds ) after which a message in the client queue will expire. + * * @since GemFire 5.7 */ public int getMessageTimeToLive(); /** - * Sets the time (in seconds ) after which a message in the client queue - * will expire. + * Sets the time (in seconds ) after which a message in the client queue will expire. + * * @throws AdminException if this bridge server is running * @since GemFire 5.7 */ public void setMessageTimeToLive(int messageTimeToLive) throws AdminException; + /** - * Sets the list of server groups this bridge server will belong to. - * By default bridge servers belong to the default global server group - * which all bridge servers always belong to. - * @param groups possibly empty array of <code>String</code> where each string - * is a server groups that this bridge server will be a member of. + * Sets the list of server groups this bridge server will belong to. By default bridge servers + * belong to the default global server group which all bridge servers always belong to. + * + * @param groups possibly empty array of <code>String</code> where each string is a server groups + * that this bridge server will be a member of. * @throws AdminException if this bridge server is running * @since GemFire 5.7 */ public void setGroups(String[] groups) throws AdminException; + /** * Returns the list of server groups that this bridge server belongs to. - * @return a possibly empty array of <code>String</code>s where - * each string is a server group. Modifying this array will not change the - * server groups that this bridge server belongs to. + * + * @return a possibly empty array of <code>String</code>s where each string is a server group. + * Modifying this array will not change the server groups that this bridge server belongs + * to. * @since GemFire 5.7 */ public String[] getGroups(); - + /** - * Get a description of the load probe for this bridge server. - * {@link ServerLoadProbe} for details on the load probe. - * @return the load probe used by this bridge - * server. + * Get a description of the load probe for this bridge server. {@link ServerLoadProbe} for details + * on the load probe. + * + * @return the load probe used by this bridge server. * @since GemFire 5.7 */ public String getLoadProbe(); /** - * Set the load probe for this bridge server. See - * {@link ServerLoadProbe} for details on how to implement - * a load probe. + * Set the load probe for this bridge server. See {@link ServerLoadProbe} for details on how to + * implement a load probe. * - * The load probe should implement DataSerializable if - * it is used with this interface, because it will be sent to the remote - * VM. - * @param loadProbe the load probe to use for - * this bridge server. - * @throws AdminException if the bridge server is running + * The load probe should implement DataSerializable if it is used with this interface, because it + * will be sent to the remote VM. + * + * @param loadProbe the load probe to use for this bridge server. + * @throws AdminException if the bridge server is running * @since GemFire 5.7 */ public void setLoadProbe(ServerLoadProbe loadProbe) throws AdminException; /** - * Get the frequency in milliseconds to poll the load probe on this bridge - * server. + * Get the frequency in milliseconds to poll the load probe on this bridge server. * * @return the frequency in milliseconds that we will poll the load probe. */ public long getLoadPollInterval(); /** - * Set the frequency in milliseconds to poll the load probe on this bridge - * server - * @param loadPollInterval the frequency in milliseconds to poll - * the load probe. Must be greater than 0. + * Set the frequency in milliseconds to poll the load probe on this bridge server + * + * @param loadPollInterval the frequency in milliseconds to poll the load probe. Must be greater + * than 0. * @throws AdminException if the bridge server is running */ public void setLoadPollInterval(long loadPollInterval) throws AdminException; - + }
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8bf39571/geode-core/src/main/java/org/apache/geode/admin/SystemMemberCache.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/org/apache/geode/admin/SystemMemberCache.java b/geode-core/src/main/java/org/apache/geode/admin/SystemMemberCache.java index 2c194ca..8517fd0 100644 --- a/geode-core/src/main/java/org/apache/geode/admin/SystemMemberCache.java +++ b/geode-core/src/main/java/org/apache/geode/admin/SystemMemberCache.java @@ -1,29 +1,29 @@ /* - * 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 org.apache.geode.cache.RegionAttributes; /** - * Administrative interface that represent's the {@link SystemMember}'s view - * of its {@link org.apache.geode.cache.Cache}. + * Administrative interface that represent's the {@link SystemMember}'s view of its + * {@link org.apache.geode.cache.Cache}. * - * @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 + * @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 SystemMemberCache { // attributes @@ -31,73 +31,68 @@ public interface SystemMemberCache { * The name of the cache. */ public String getName(); + /** * Value that uniquely identifies an instance of a cache for a given member. */ public int getId(); + /** * Indicates if this cache has been closed. + * * @return true, if this cache is closed; false, otherwise */ public boolean isClosed(); + /** - * Gets the number of seconds a cache operation will wait to obtain - * a distributed lock lease. + * Gets the number of seconds a cache operation will wait to obtain a distributed lock lease. */ public int getLockTimeout(); + /** - * Sets the number of seconds a cache operation may wait to obtain a - * distributed lock lease before timing out. + * Sets the number of seconds a cache operation may wait to obtain a distributed lock lease before + * timing out. * - * @throws AdminException - * If a problem is encountered while setting the lock - * timeout + * @throws AdminException If a problem is encountered while setting the lock timeout * * @see org.apache.geode.cache.Cache#setLockTimeout */ public void setLockTimeout(int seconds) throws AdminException; - + /** - * Gets the length, in seconds, of distributed lock leases obtained - * by this cache. + * Gets the length, in seconds, of distributed lock leases obtained by this cache. */ public int getLockLease(); + /** - * Sets the length, in seconds, of distributed lock leases obtained - * by this cache. + * Sets the length, in seconds, of distributed lock leases obtained by this cache. * - * @throws AdminException - * If a problem is encountered while setting the lock - * lease + * @throws AdminException If a problem is encountered while setting the lock lease * * @see org.apache.geode.cache.Cache#setLockLease */ public void setLockLease(int seconds) throws AdminException; - + /** - * Gets the number of seconds a cache - * {@link org.apache.geode.cache.Region#get(Object) get} operation - * can spend searching for a value before it times out. - * The search includes any time spent loading the object. - * When the search times out it causes the get to fail by throwing - * an exception. + * Gets the number of seconds a cache {@link org.apache.geode.cache.Region#get(Object) get} + * operation can spend searching for a value before it times out. The search includes any time + * spent loading the object. When the search times out it causes the get to fail by throwing an + * exception. */ public int getSearchTimeout(); + /** - * Sets the number of seconds a cache get operation can spend searching - * for a value. + * Sets the number of seconds a cache get operation can spend searching for a value. * - * @throws AdminException - * If a problem is encountered while setting the search - * timeout + * @throws AdminException If a problem is encountered while setting the search timeout * * @see org.apache.geode.cache.Cache#setSearchTimeout */ public void setSearchTimeout(int seconds) throws AdminException; + /** - * Returns number of seconds since this member's cache has been created. - * Returns <code>-1</code> if this member does not have a cache or its cache - * has been closed. + * Returns number of seconds since this member's cache has been created. Returns <code>-1</code> + * if this member does not have a cache or its cache has been closed. */ public int getUpTime(); @@ -114,10 +109,9 @@ public interface SystemMemberCache { public Statistic[] getStatistics(); /** - * Return the existing region (or subregion) with the specified - * path that already exists in the cache. - * Whether or not the path starts with a forward slash it is interpreted as a - * full path starting at a root. + * Return the existing region (or subregion) with the specified path that already exists in the + * cache. Whether or not the path starts with a forward slash it is interpreted as a full path + * starting at a root. * * @param path the path to the region * @return the Region or null if not found @@ -128,74 +122,59 @@ public interface SystemMemberCache { /** * Creates a VM root <code>Region</code> in this cache. * - * @param name - * The name of the region to create - * @param attrs - * The attributes of the root region + * @param name The name of the region to create + * @param attrs The attributes of the root region * - * @throws AdminException - * If the region cannot be created + * @throws AdminException If the region cannot be created * * @since GemFire 4.0 * @deprecated as of GemFire 5.0, use {@link #createRegion} instead */ @Deprecated - public SystemMemberRegion createVMRegion(String name, - RegionAttributes attrs) - throws AdminException; + public SystemMemberRegion createVMRegion(String name, RegionAttributes attrs) + throws AdminException; /** * Creates a root <code>Region</code> in this cache. * - * @param name - * The name of the region to create - * @param attrs - * The attributes of the root region + * @param name The name of the region to create + * @param attrs The attributes of the root region * - * @throws AdminException - * If the region cannot be created + * @throws AdminException If the region cannot be created * * @since GemFire 5.0 */ - public SystemMemberRegion createRegion(String name, - RegionAttributes attrs) - throws AdminException; + public SystemMemberRegion createRegion(String name, RegionAttributes attrs) throws AdminException; /** - * Updates the state of this cache instance. Note that once a cache - * instance is closed refresh will never change the state of that instance. + * Updates the state of this cache instance. Note that once a cache instance is closed refresh + * will never change the state of that instance. */ public void refresh(); /** - * Adds a new, unstarted cache server that will serve the contents - * of this cache to clients. + * Adds a new, unstarted cache server that will serve the contents of this cache to clients. * * @see org.apache.geode.cache.Cache#addCacheServer * * @since GemFire 5.7 */ - public SystemMemberCacheServer addCacheServer() - throws AdminException; + public SystemMemberCacheServer addCacheServer() throws AdminException; /** - * Returns the cache servers that run in this member's VM. Note - * that this list will not be updated until {@link #refresh} is - * called. + * Returns the cache servers that run in this member's VM. Note that this list will not be updated + * until {@link #refresh} is called. * * @see org.apache.geode.cache.Cache#getCacheServers * * @since GemFire 5.7 */ - public SystemMemberCacheServer[] getCacheServers() - throws AdminException; + public SystemMemberCacheServer[] getCacheServers() throws AdminException; /** - * Returns whether or not this cache acts as a server. This method - * will always return <code>true</code> for the - * <code>SystemMemberCache</code> obtained from a {@link - * CacheServer}. Note that this value will not be updated until - * {@link #refresh} is invoked. + * Returns whether or not this cache acts as a server. This method will always return + * <code>true</code> for the <code>SystemMemberCache</code> obtained from a {@link CacheServer}. + * Note that this value will not be updated until {@link #refresh} is invoked. * * @since GemFire 4.0 */ http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8bf39571/geode-core/src/main/java/org/apache/geode/admin/SystemMemberCacheEvent.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/org/apache/geode/admin/SystemMemberCacheEvent.java b/geode-core/src/main/java/org/apache/geode/admin/SystemMemberCacheEvent.java index dee9bc1..d26ee40 100644 --- a/geode-core/src/main/java/org/apache/geode/admin/SystemMemberCacheEvent.java +++ b/geode-core/src/main/java/org/apache/geode/admin/SystemMemberCacheEvent.java @@ -1,29 +1,29 @@ /* - * 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 org.apache.geode.cache.Operation; + /** - * An event that describes an operation on a cache. - * Instances of this are delivered to a {@link SystemMemberCacheListener} when a - * a cache is created or closed. + * An event that describes an operation on a cache. Instances of this are delivered to a + * {@link SystemMemberCacheListener} when a a cache is created or closed. * * @since GemFire 5.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 SystemMemberCacheEvent extends SystemMembershipEvent { /** http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8bf39571/geode-core/src/main/java/org/apache/geode/admin/SystemMemberCacheListener.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/org/apache/geode/admin/SystemMemberCacheListener.java b/geode-core/src/main/java/org/apache/geode/admin/SystemMemberCacheListener.java index 0d258b6..4008bdf 100644 --- a/geode-core/src/main/java/org/apache/geode/admin/SystemMemberCacheListener.java +++ b/geode-core/src/main/java/org/apache/geode/admin/SystemMemberCacheListener.java @@ -1,37 +1,38 @@ /* - * 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 org.apache.geode.cache.*; /** - * A listener whose callback methods can be used to track the lifecycle of - * {@link Cache caches} and {@link Region regions} in the GemFire distributed system. + * A listener whose callback methods can be used to track the lifecycle of {@link Cache caches} and + * {@link Region regions} in the GemFire distributed system. * * @see AdminDistributedSystem#addCacheListener * @see AdminDistributedSystem#removeCacheListener * * @since GemFire 5.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 SystemMemberCacheListener { /** * Invoked after a region is created in any node of distributed system. + * * @param event describes the region that was created. * @see CacheFactory#create * @see Cache#createRegion @@ -41,11 +42,12 @@ public interface SystemMemberCacheListener { /** * Invoked when a region is destroyed or closed in any node of distributed system. - * @param event describes the region that was lost. The operation on this event - * can be used to determine the actual operation that caused the loss. Note that - * {@link Cache#close()} invokes this callback with <code>Operation.CACHE_CLOSE</code> - * for each region in the closed cache and it invokes {@link #afterCacheClose}. - + * + * @param event describes the region that was lost. The operation on this event can be used to + * determine the actual operation that caused the loss. Note that {@link Cache#close()} + * invokes this callback with <code>Operation.CACHE_CLOSE</code> for each region in the + * closed cache and it invokes {@link #afterCacheClose}. + * * @see Cache#close() * @see Region#close * @see Region#localDestroyRegion() @@ -54,17 +56,19 @@ public interface SystemMemberCacheListener { public void afterRegionLoss(SystemMemberRegionEvent event); /** - * Invoked after a cache is created in any node of a distributed system. - * Note that this callback will be done before any regions are created in the - * cache. + * Invoked after a cache is created in any node of a distributed system. Note that this callback + * will be done before any regions are created in the cache. + * * @param event describes the member that created the cache. * @see CacheFactory#create */ public void afterCacheCreate(SystemMemberCacheEvent event); + /** - * Invoked after a cache is closed in any node of a distributed system. - * This callback is done after those done for each region in the cache. - * This callback is not done if the distributed member that has a cache crashes. + * Invoked after a cache is closed in any node of a distributed system. This callback is done + * after those done for each region in the cache. This callback is not done if the distributed + * member that has a cache crashes. + * * @param event describes the member that closed its cache. * @see Cache#close() */ http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8bf39571/geode-core/src/main/java/org/apache/geode/admin/SystemMemberCacheServer.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/org/apache/geode/admin/SystemMemberCacheServer.java b/geode-core/src/main/java/org/apache/geode/admin/SystemMemberCacheServer.java index daf2199..edfa356 100755 --- a/geode-core/src/main/java/org/apache/geode/admin/SystemMemberCacheServer.java +++ b/geode-core/src/main/java/org/apache/geode/admin/SystemMemberCacheServer.java @@ -1,68 +1,61 @@ /* - * 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 org.apache.geode.cache.server.ServerLoadProbe; /** - * Administrative interface that represents a {@link - * org.apache.geode.cache.server.CacheServer CacheServer} that - * serves the contents of a system member's cache to clients. + * Administrative interface that represents a {@link org.apache.geode.cache.server.CacheServer + * CacheServer} that serves the contents of a system member's cache to clients. * * @see SystemMemberCache#addCacheServer * * @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 SystemMemberCacheServer { - /** - * Returns the port on which this cache server listens for - * clients to connect. + /** + * Returns the port on which this cache server listens for clients to connect. */ public int getPort(); /** - * Sets the port on which this cache server listens for - * clients to connect. + * Sets the port on which this cache server listens for clients to connect. * - * @throws AdminException - * If this cache server is running + * @throws AdminException If this cache server is running */ public void setPort(int port) throws AdminException; /** - * Starts this cache server. Once the server is running, its - * configuration cannot be changed. + * Starts this cache server. Once the server is running, its configuration cannot be changed. * - * @throws AdminException - * If an error occurs while starting the cache server + * @throws AdminException If an error occurs while starting the cache server */ public void start() throws AdminException; - /** + /** * Returns whether or not this cache server is running */ public boolean isRunning(); /** - * Stops this cache server. Note that the - * <code>CacheServer</code> can be reconfigured and restarted if - * desired. + * Stops this cache server. Note that the <code>CacheServer</code> can be reconfigured and + * restarted if desired. */ public void stop() throws AdminException; @@ -72,80 +65,87 @@ public interface SystemMemberCacheServer { public void refresh(); /** - * Returns a string representing the ip address or host name that this server - * will listen on. + * Returns a string representing the ip address or host name that this server will listen on. + * * @return the ip address or host name that this server is to listen on * @since GemFire 5.7 */ public String getBindAddress(); + /** - * Sets the ip address or host name that this server is to listen on for - * client connections. - * <p>Setting a specific bind address will cause the cache server to always - * use this address and ignore any address specified by "server-bind-address" - * or "bind-address" in the <code>gemfire.properties</code> file - * (see {@link org.apache.geode.distributed.DistributedSystem} - * for a description of these properties). - * <p> A <code>null</code> value will be treated the same as the default "". - * <p> The default value does not override the gemfire.properties. If you wish to - * override the properties and want to have your server bind to all local - * addresses then use this string <code>"0.0.0.0"</code>. + * Sets the ip address or host name that this server is to listen on for client connections. + * <p> + * Setting a specific bind address will cause the cache server to always use this address and + * ignore any address specified by "server-bind-address" or "bind-address" in the + * <code>gemfire.properties</code> file (see + * {@link org.apache.geode.distributed.DistributedSystem} for a description of these properties). + * <p> + * A <code>null</code> value will be treated the same as the default "". + * <p> + * The default value does not override the gemfire.properties. If you wish to override the + * properties and want to have your server bind to all local addresses then use this string + * <code>"0.0.0.0"</code>. + * * @param address the ip address or host name that this server is to listen on * @throws AdminException if this cache server is running * @since GemFire 5.7 */ public void setBindAddress(String address) throws AdminException; + /** - * Returns a string representing the ip address or host name that server locators - * will tell clients that this server is listening on. - * @return the ip address or host name to give to clients so they can connect - * to this server + * Returns a string representing the ip address or host name that server locators will tell + * clients that this server is listening on. + * + * @return the ip address or host name to give to clients so they can connect to this server * @since GemFire 5.7 */ public String getHostnameForClients(); + /** - * Sets the ip address or host name that this server is to listen on for - * client connections. - * <p>Setting a specific hostname-for-clients will cause server locators - * to use this value when telling clients how to connect to this server. - * <p> The default value causes the bind-address to be given to clients - * <p> A <code>null</code> value will be treated the same as the default "". - * @param name the ip address or host name that will be given to clients - * so they can connect to this server + * Sets the ip address or host name that this server is to listen on for client connections. + * <p> + * Setting a specific hostname-for-clients will cause server locators to use this value when + * telling clients how to connect to this server. + * <p> + * The default value causes the bind-address to be given to clients + * <p> + * A <code>null</code> value will be treated the same as the default "". + * + * @param name the ip address or host name that will be given to clients so they can connect to + * this server * @throws AdminException if this cache server is running * @since GemFire 5.7 */ public void setHostnameForClients(String name) throws AdminException; + /** - * Sets whether or not this cache server should notify clients based on - * key subscription. + * Sets whether or not this cache server should notify clients based on key subscription. * - * If false, then an update to any key on the server causes an update to - * be sent to all clients. This update does not push the actual data to the - * clients. Instead, it causes the client to locally invalidate or destroy - * the corresponding entry. The next time the client requests the key, it - * goes to the cache server for the value. + * If false, then an update to any key on the server causes an update to be sent to all clients. + * This update does not push the actual data to the clients. Instead, it causes the client to + * locally invalidate or destroy the corresponding entry. The next time the client requests the + * key, it goes to the cache server for the value. * - * If true, then an update to any key on the server causes an update to be - * sent to only those clients who have registered interest in that key. Other - * clients are not notified of the change. In addition, the actual value is - * pushed to the client. The client does not need to request the new value - * from the cache server. + * If true, then an update to any key on the server causes an update to be sent to only those + * clients who have registered interest in that key. Other clients are not notified of the change. + * In addition, the actual value is pushed to the client. The client does not need to request the + * new value from the cache server. + * * @throws AdminException if this cache server is running * @since GemFire 5.7 */ public void setNotifyBySubscription(boolean b) throws AdminException; /** - * Answers whether or not this cache server should notify clients based on - * key subscription. + * Answers whether or not this cache server should notify clients based on key subscription. + * * @since GemFire 5.7 */ public boolean getNotifyBySubscription(); /** - * Sets the buffer size in bytes of the socket connection for this - * <code>CacheServer</code>. The default is 32768 bytes. + * Sets the buffer size in bytes of the socket connection for this <code>CacheServer</code>. The + * default is 32768 bytes. * * @param socketBufferSize The size in bytes of the socket buffer * @throws AdminException if this cache server is running @@ -154,155 +154,155 @@ public interface SystemMemberCacheServer { public void setSocketBufferSize(int socketBufferSize) throws AdminException; /** - * Returns the configured buffer size of the socket connection for this - * <code>CacheServer</code>. The default is 32768 bytes. - * @return the configured buffer size of the socket connection for this - * <code>CacheServer</code> + * Returns the configured buffer size of the socket connection for this <code>CacheServer</code>. + * The default is 32768 bytes. + * + * @return the configured buffer size of the socket connection for this <code>CacheServer</code> * @since GemFire 5.7 */ public int getSocketBufferSize(); /** - * Sets the maximum amount of time between client pings. This value is - * used by the <code>ClientHealthMonitor</code> to determine the health - * of this <code>CacheServer</code>'s clients. The default is 60000 ms. + * Sets the maximum amount of time between client pings. This value is used by the + * <code>ClientHealthMonitor</code> to determine the health of this <code>CacheServer</code>'s + * clients. The default is 60000 ms. * - * @param maximumTimeBetweenPings The maximum amount of time between client - * pings + * @param maximumTimeBetweenPings The maximum amount of time between client pings * @throws AdminException if this cache server is running * @since GemFire 5.7 */ public void setMaximumTimeBetweenPings(int maximumTimeBetweenPings) throws AdminException; /** - * Returns the maximum amount of time between client pings. This value is - * used by the <code>ClientHealthMonitor</code> to determine the health - * of this <code>CacheServer</code>'s clients. The default is 60000 ms. + * Returns the maximum amount of time between client pings. This value is used by the + * <code>ClientHealthMonitor</code> to determine the health of this <code>CacheServer</code>'s + * clients. The default is 60000 ms. + * * @return the maximum amount of time between client pings. * @since GemFire 5.7 */ public int getMaximumTimeBetweenPings(); - /** - * Returns the maximum allowed client connections + /** + * Returns the maximum allowed client connections + * * @since GemFire 5.7 */ public int getMaxConnections(); /** - * Sets the maxium number of client connections allowed. - * When the maximum is reached the server will stop accepting - * connections. + * Sets the maxium number of client connections allowed. When the maximum is reached the server + * will stop accepting connections. + * * @throws AdminException if this cache server is running * @since GemFire 5.7 */ public void setMaxConnections(int maxCons) throws AdminException; - /** - * Returns the maxium number of threads allowed in this server to service - * client requests. - * The default of <code>0</code> causes the server to dedicate a thread for - * every client connection. + /** + * Returns the maxium number of threads allowed in this server to service client requests. The + * default of <code>0</code> causes the server to dedicate a thread for every client connection. + * * @since GemFire 5.7 */ public int getMaxThreads(); /** - * Sets the maxium number of threads allowed in this server to service - * client requests. - * The default of <code>0</code> causes the server to dedicate a thread for - * every client connection. + * Sets the maxium number of threads allowed in this server to service client requests. The + * default of <code>0</code> causes the server to dedicate a thread for every client connection. + * * @throws AdminException if this cache server is running * @since GemFire 5.7 */ public void setMaxThreads(int maxThreads) throws AdminException; /** - * Returns the maximum number of messages that can be enqueued in a - * client-queue. + * Returns the maximum number of messages that can be enqueued in a client-queue. + * * @since GemFire 5.7 */ public int getMaximumMessageCount(); /** * Sets maximum number of messages that can be enqueued in a client-queue. + * * @throws AdminException if this cache server is running * @since GemFire 5.7 */ public void setMaximumMessageCount(int maxMessageCount) throws AdminException; - + /** - * Returns the time (in seconds ) after which a message in the client queue - * will expire. + * Returns the time (in seconds ) after which a message in the client queue will expire. + * * @since GemFire 5.7 */ public int getMessageTimeToLive(); /** - * Sets the time (in seconds ) after which a message in the client queue - * will expire. + * Sets the time (in seconds ) after which a message in the client queue will expire. + * * @throws AdminException if this cache server is running * @since GemFire 5.7 */ public void setMessageTimeToLive(int messageTimeToLive) throws AdminException; + /** - * Sets the list of server groups this cache server will belong to. - * By default cache servers belong to the default global server group - * which all cache servers always belong to. - * @param groups possibly empty array of <code>String</code> where each string - * is a server groups that this cache server will be a member of. + * Sets the list of server groups this cache server will belong to. By default cache servers + * belong to the default global server group which all cache servers always belong to. + * + * @param groups possibly empty array of <code>String</code> where each string is a server groups + * that this cache server will be a member of. * @throws AdminException if this cache server is running * @since GemFire 5.7 */ public void setGroups(String[] groups) throws AdminException; + /** * Returns the list of server groups that this cache server belongs to. - * @return a possibly empty array of <code>String</code>s where - * each string is a server group. Modifying this array will not change the - * server groups that this cache server belongs to. + * + * @return a possibly empty array of <code>String</code>s where each string is a server group. + * Modifying this array will not change the server groups that this cache server belongs + * to. * @since GemFire 5.7 */ public String[] getGroups(); - + /** - * Get a description of the load probe for this cache server. - * {@link ServerLoadProbe} for details on the load probe. - * @return the load probe used by this cache - * server. + * Get a description of the load probe for this cache server. {@link ServerLoadProbe} for details + * on the load probe. + * + * @return the load probe used by this cache server. * @since GemFire 5.7 */ public String getLoadProbe(); /** - * Set the load probe for this cache server. See - * {@link ServerLoadProbe} for details on how to implement - * a load probe. + * Set the load probe for this cache server. See {@link ServerLoadProbe} for details on how to + * implement a load probe. * - * The load probe should implement DataSerializable if - * it is used with this interface, because it will be sent to the remote - * VM. - * @param loadProbe the load probe to use for - * this cache server. - * @throws AdminException if the cache server is running + * The load probe should implement DataSerializable if it is used with this interface, because it + * will be sent to the remote VM. + * + * @param loadProbe the load probe to use for this cache server. + * @throws AdminException if the cache server is running * @since GemFire 5.7 */ public void setLoadProbe(ServerLoadProbe loadProbe) throws AdminException; /** - * Get the frequency in milliseconds to poll the load probe on this cache - * server. + * Get the frequency in milliseconds to poll the load probe on this cache server. * * @return the frequency in milliseconds that we will poll the load probe. */ public long getLoadPollInterval(); /** - * Set the frequency in milliseconds to poll the load probe on this cache - * server - * @param loadPollInterval the frequency in milliseconds to poll - * the load probe. Must be greater than 0. + * Set the frequency in milliseconds to poll the load probe on this cache server + * + * @param loadPollInterval the frequency in milliseconds to poll the load probe. Must be greater + * than 0. * @throws AdminException if the cache server is running */ public void setLoadPollInterval(long loadPollInterval) throws AdminException; - + } http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8bf39571/geode-core/src/main/java/org/apache/geode/admin/SystemMemberRegion.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/org/apache/geode/admin/SystemMemberRegion.java b/geode-core/src/main/java/org/apache/geode/admin/SystemMemberRegion.java index 22acdcc..d26ce39 100644 --- a/geode-core/src/main/java/org/apache/geode/admin/SystemMemberRegion.java +++ b/geode-core/src/main/java/org/apache/geode/admin/SystemMemberRegion.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,15 +18,15 @@ import org.apache.geode.cache.*; import java.io.File; /** - * Administrative interface that represent's the {@link - * SystemMember}'s view of one of its cache's {@link - * org.apache.geode.cache.Region}s. If the region in the remote - * system member is closed or destroyed, the methods of - * <code>SystemMemberRegion</code> will throw {@link - * RegionNotFoundException}. + * Administrative interface that represent's the {@link SystemMember}'s view of one of its cache's + * {@link org.apache.geode.cache.Region}s. If the region in the remote system member is closed or + * destroyed, the methods of <code>SystemMemberRegion</code> will throw + * {@link RegionNotFoundException}. * * @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 SystemMemberRegion { // attributes @@ -38,10 +36,9 @@ public interface SystemMemberRegion { * @see org.apache.geode.cache.Region#getName */ public String getName(); - + /** - * Returns the full path name that identifies this region in its - * cache. + * Returns the full path name that identifies this region in its cache. * * @see org.apache.geode.cache.Region#getFullPath */ @@ -53,16 +50,14 @@ public interface SystemMemberRegion { public java.util.Set getSubregionNames(); /** - * Returns the full path of each of the subregions of this region. - * These paths are suitable for use with {@link - * SystemMemberCache#getRegion}. + * Returns the full path of each of the subregions of this region. These paths are suitable for + * use with {@link SystemMemberCache#getRegion}. */ public java.util.Set getSubregionFullPaths(); /** - * Returns a description of any user attribute associated with this - * region. The description includes the classname of the user - * attribute object as well as its <code>toString</code> + * Returns a description of any user attribute associated with this region. The description + * includes the classname of the user attribute object as well as its <code>toString</code> * representation. */ public String getUserAttribute(); @@ -71,22 +66,22 @@ public interface SystemMemberRegion { * Returns a description of any CacheLoader associated with this region. */ public String getCacheLoader(); + /** * Returns a description of any CacheWriter associated with this region. */ public String getCacheWriter(); /** - * Returns the <code>EvictionAttributes</code> that configure how - * entries in the the region are evicted + * Returns the <code>EvictionAttributes</code> that configure how entries in the the region are + * evicted */ public EvictionAttributes getEvictionAttributes(); /** - * Returns a description of the CacheListener in this region's attributes. If - * there is more than 1 CacheListener defined for a region this method will - * return the description of the 1st CacheListener returned from - * {@link #getCacheListeners} + * Returns a description of the CacheListener in this region's attributes. If there is more than 1 + * CacheListener defined for a region this method will return the description of the 1st + * CacheListener returned from {@link #getCacheListeners} * * @deprecated as of 6.0 use getCacheListeners() instead */ @@ -94,10 +89,9 @@ public interface SystemMemberRegion { public String getCacheListener(); /** - * 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 names 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 names of all the CacheListeners * * @return String[] the region's <code>CacheListeners</code> as a String array * @since GemFire 6.0 @@ -136,10 +130,11 @@ public interface SystemMemberRegion { /** * string describing the CustomExpiry for entry-time-to-live + * * @return the CustomExpiry for entry-time-to-live */ public String getCustomEntryTimeToLive(); - + /** * Returns the RegionIdleTimeout time limit in this region's attributes. */ @@ -159,29 +154,30 @@ public interface SystemMemberRegion { * Returns the EntryIdleTimeout action in this region's attributes. */ public ExpirationAction getEntryIdleTimeoutAction(); - + /** * string describing the CustomExpiry for entry-idle-timeout + * * @return the CustomExpiry for entry-idle-timeout */ public String getCustomEntryIdleTimeout(); - + /** * Returns the MirrorType in this region's attributes. + * * @deprecated as of 5.0, you should use getDataPolicy instead */ @Deprecated public MirrorType getMirrorType(); - + /** * Returns the DataPolicy in this region's attributes. */ public DataPolicy getDataPolicy(); - - /** - + /** - * Returns the Scope in this region's attributes. + * + * /** Returns the Scope in this region's attributes. */ public Scope getScope(); @@ -201,8 +197,7 @@ public interface SystemMemberRegion { public int getConcurrencyLevel(); /** - * Returns whether or not conflicting concurrent operations on this region - * are prevented + * Returns whether or not conflicting concurrent operations on this region are prevented */ public boolean getConcurrencyChecksEnabled(); @@ -212,21 +207,19 @@ public interface SystemMemberRegion { public boolean getStatisticsEnabled(); /** - * Returns whether or not a persistent backup should be made of the - * region (as opposed to just writing the overflow data to disk). + * Returns whether or not a persistent backup should be made of the region (as opposed to just + * writing the overflow data to disk). */ public boolean getPersistBackup(); /** - * Returns the <code>DiskWriteAttributes</code> that configure how - * the region is written to disk. + * Returns the <code>DiskWriteAttributes</code> that configure how the region is written to disk. */ public DiskWriteAttributes getDiskWriteAttributes(); /** - * Returns the directories to which the region's data are written. If - * multiple directories are used, GemFire will attempt to distribute the - * data evenly amongst them. + * Returns the directories to which the region's data are written. If multiple directories are + * used, GemFire will attempt to distribute the data evenly amongst them. */ public File[] getDiskDirs(); @@ -234,7 +227,7 @@ public interface SystemMemberRegion { * Returns the number of entries currently in this region. */ public int getEntryCount(); - + /** * Returns the number of subregions currently in this region. */ @@ -267,8 +260,9 @@ public interface SystemMemberRegion { /** * Returns whether or not acks are sent after an update is processed. - * @return False if acks are sent after updates are processed; - * true if acks are sent before updates are processed. + * + * @return False if acks are sent after updates are processed; true if acks are sent before + * updates are processed. * * @since GemFire 4.1 */ @@ -276,43 +270,42 @@ public interface SystemMemberRegion { // operations /** - * Updates the state of this region instance. Note that once a cache - * instance is closed refresh will never change the state of its regions. + * Updates the state of this region instance. Note that once a cache instance is closed refresh + * will never change the state of its regions. */ public void refresh(); /** * Creates a subregion of this region. * - * @param name - * The name of the region to create - * @param attrs - * The attributes of the root region + * @param name The name of the region to create + * @param attrs The attributes of the root region * - * @throws AdminException - * If the region cannot be created + * @throws AdminException If the region cannot be created * * @since GemFire 4.0 */ - public SystemMemberRegion createSubregion(String name, - RegionAttributes attrs) - throws AdminException; + public SystemMemberRegion createSubregion(String name, RegionAttributes attrs) + throws AdminException; /** - * Returns the <code>MembershipAttributes</code> that configure required - * roles for reliable access to the region. + * Returns the <code>MembershipAttributes</code> that configure required roles for reliable access + * to the region. + * * @deprecated this API is scheduled to be removed */ public MembershipAttributes getMembershipAttributes(); - + /** * Returns the <code>SubscriptionAttributes</code> for the region. + * * @since GemFire 5.0 */ public SubscriptionAttributes getSubscriptionAttributes(); - + /** * Returns the <code>PartitionAttributes</code> for the region. + * * @since GemFire 5.7 */ public PartitionAttributes getPartitionAttributes(); http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8bf39571/geode-core/src/main/java/org/apache/geode/admin/SystemMemberRegionEvent.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/org/apache/geode/admin/SystemMemberRegionEvent.java b/geode-core/src/main/java/org/apache/geode/admin/SystemMemberRegionEvent.java index 2dd1ffd..27ee8ae 100644 --- a/geode-core/src/main/java/org/apache/geode/admin/SystemMemberRegionEvent.java +++ b/geode-core/src/main/java/org/apache/geode/admin/SystemMemberRegionEvent.java @@ -1,28 +1,27 @@ /* - * 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; /** - * 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 - * @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 SystemMemberRegionEvent extends SystemMemberCacheEvent { /** http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8bf39571/geode-core/src/main/java/org/apache/geode/admin/SystemMemberType.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/org/apache/geode/admin/SystemMemberType.java b/geode-core/src/main/java/org/apache/geode/admin/SystemMemberType.java index 7ba99fb..c95d32e 100755 --- a/geode-core/src/main/java/org/apache/geode/admin/SystemMemberType.java +++ b/geode-core/src/main/java/org/apache/geode/admin/SystemMemberType.java @@ -1,46 +1,45 @@ /* - * 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.io.*; +// import java.io.*; /** * Type-safe definition for system members. * - * @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 class SystemMemberType implements java.io.Serializable { private static final long serialVersionUID = 3284366994485749302L; - + /** GemFire shared-memory manager connected to the distributed system */ - public static final SystemMemberType MANAGER = - new SystemMemberType("GemFireManager"); + public static final SystemMemberType MANAGER = new SystemMemberType("GemFireManager"); /** Application connected to the distributed system */ - public static final SystemMemberType APPLICATION = - new SystemMemberType("Application"); + public static final SystemMemberType APPLICATION = new SystemMemberType("Application"); /** GemFire Cache VM connected to the distributed system */ - public static final SystemMemberType CACHE_VM = - new SystemMemberType("CacheVm"); + public static final SystemMemberType CACHE_VM = new SystemMemberType("CacheVm"); - /** GemFire Cache Server connected to the distributed system + /** + * GemFire Cache Server connected to the distributed system + * * @deprecated as of 5.7 use {@link #CACHE_VM} instead. */ @Deprecated @@ -49,25 +48,24 @@ public class SystemMemberType implements java.io.Serializable { /** The display-friendly name of this system member type. */ private final transient String name; - + // The 4 declarations below are necessary for serialization /** int used as ordinal to represent this Scope */ public final int ordinal = nextOrdinal++; private static int nextOrdinal = 0; - - private static final SystemMemberType[] VALUES = - { MANAGER, APPLICATION, CACHE_VM }; + + private static final SystemMemberType[] VALUES = {MANAGER, APPLICATION, CACHE_VM}; private Object readResolve() throws java.io.ObjectStreamException { - return VALUES[ordinal]; // Canonicalize + return VALUES[ordinal]; // Canonicalize } - + /** Creates a new instance of SystemMemberType. */ private SystemMemberType(String name) { this.name = name; } - + /** Return the SystemMemberType represented by specified ordinal */ public static SystemMemberType fromOrdinal(int ordinal) { return VALUES[ordinal]; @@ -76,70 +74,77 @@ public class SystemMemberType implements java.io.Serializable { public String getName() { return this.name; } - + /** Return whether this is <code>MANAGER</code>. */ public boolean isManager() { return this.equals(MANAGER); } - + /** Return whether this is <code>APPLICATION</code>. */ public boolean isApplication() { return this.equals(APPLICATION); } - /** Return whether this is <code>CACHE_SERVER</code>. + /** + * Return whether this is <code>CACHE_SERVER</code>. + * * @deprecated as of 5.7 use {@link #isCacheVm} instead. */ @Deprecated public boolean isCacheServer() { return isCacheVm(); } - /** Return whether this is <code>CACHE_VM</code>. + + /** + * Return whether this is <code>CACHE_VM</code>. */ public boolean isCacheVm() { return this.equals(CACHE_VM); } - - /** + + /** * Returns a string representation for this system member type. * * @return the name of this system member type */ @Override public String toString() { - return this.name; + return this.name; } - /** - * Indicates whether some other object is "equal to" this one. - * - * @param other the reference object with which to compare. - * @return true if this object is the same as the obj argument; - * false otherwise. - */ + /** + * Indicates whether some other object is "equal to" this one. + * + * @param other the reference object with which to compare. + * @return true if this object is the same as the obj argument; false otherwise. + */ @Override - public boolean equals(Object other) { - if (other == this) return true; - if (other == null) return false; - if (!(other instanceof SystemMemberType)) return false; - final SystemMemberType that = (SystemMemberType) other; - if (this.ordinal != that.ordinal) return false; - return true; - } - - /** - * Returns a hash code for the object. This method is supported for the - * benefit of hashtables such as those provided by java.util.Hashtable. - * - * @return the integer 0 if description is null; otherwise a unique integer. - */ + public boolean equals(Object other) { + if (other == this) + return true; + if (other == null) + return false; + if (!(other instanceof SystemMemberType)) + return false; + final SystemMemberType that = (SystemMemberType) other; + if (this.ordinal != that.ordinal) + return false; + return true; + } + + /** + * Returns a hash code for the object. This method is supported for the benefit of hashtables such + * as those provided by java.util.Hashtable. + * + * @return the integer 0 if description is null; otherwise a unique integer. + */ @Override - public int hashCode() { - int result = 17; - final int mult = 37; - result = mult * result + this.ordinal; - return result; - } - + public int hashCode() { + int result = 17; + final int mult = 37; + result = mult * result + this.ordinal; + return result; + } + } http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8bf39571/geode-core/src/main/java/org/apache/geode/admin/SystemMembershipEvent.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/org/apache/geode/admin/SystemMembershipEvent.java b/geode-core/src/main/java/org/apache/geode/admin/SystemMembershipEvent.java index 9319de5..d7850b4 100644 --- a/geode-core/src/main/java/org/apache/geode/admin/SystemMembershipEvent.java +++ b/geode-core/src/main/java/org/apache/geode/admin/SystemMembershipEvent.java @@ -1,29 +1,30 @@ /* - * 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 org.apache.geode.distributed.DistributedMember; + /** - * An event that describes the distributed member originated this event. - * Instances of this are delivered to a {@link SystemMembershipListener} when a - * member has joined or left the distributed system. + * An event that describes the distributed member originated this event. Instances of this are + * delivered to a {@link SystemMembershipListener} when a member has joined or left the 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 + * @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 SystemMembershipEvent { /** @@ -33,6 +34,7 @@ public interface SystemMembershipEvent { /** * Returns the {@link DistributedMember} that this event originated in. + * * @return the member that performed the operation that originated this event. * @since GemFire 5.0 */
