com.gemstone.gemfire.distributed.internal.StartupMessageData Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gemfire-core Show documentation
Show all versions of gemfire-core Show documentation
SnappyData store based off Pivotal GemFireXD
/*
* Copyright (c) 2010-2015 Pivotal Software, Inc. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you
* may not use this file except in compliance with the License. You
* may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
* implied. See the License for the specific language governing
* permissions and limitations under the License. See accompanying
* LICENSE file.
*/
package com.gemstone.gemfire.distributed.internal;
import java.io.DataInput;
import java.io.DataOutput;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Properties;
import java.util.StringTokenizer;
import com.gemstone.gemfire.DataSerializer;
import com.gemstone.gemfire.internal.GemFireVersion;
/**
* Provides optional data fields as properties for StartupMessage and
* StartupResponseMessage. This is handled by serializing and deserializing
* a new Properties instance if and only if the member version is 6.6.3 or
* greater. New fields can be added to the Properties without breaking
* backwards compatibility. All new fields added should be written to allow
* for version compatibility.
*
* @author Kirk Lund
* @since 7.0
*/
class StartupMessageData {
static final String SUPPORTED_VERSION = "6.6.3";
static final String HOSTED_LOCATORS = "HL";
static final String COMMA_DELIMITER = ",";
static final String MCAST_PORT = "MP";
static final String MCAST_HOST_ADDRESS = "MHA";
private final Properties optionalFields;
/**
* Constructs a new instance with empty Properties. After construction
* the instance should optionally invoke one or more "write" methods such
* as {@link #writeHostedLocators(Collection)} before invoking {@link
* #toData(DataOutput)} to marshal the Properties into the DataOutput
* (onto the wire).
*/
StartupMessageData() {
this.optionalFields = new Properties();
}
/**
* Constructs a new instance which deserializes any optional fields it
* finds in the DataInput (from the wire) if the specified version is
* greater than or equal to the minimum {@link #SUPPORTED_VERSION}.
*
* @throws ClassNotFoundException
* @throws IOException
*/
StartupMessageData(DataInput in, String version) throws ClassNotFoundException, IOException {
// [bruce] commenting this out for the GemFireXD Cheetah 1.0 release. It should be removed
// from the GemFire Cedar branch as well. Future versioning work should use the
// version ordinal found in the DataInput passed to fromData methods.
// if (GemFireVersion.compareVersions(version, StartupMessageData.SUPPORTED_VERSION) >= 0) {
this.optionalFields = (Properties) DataSerializer.readObject(in);
// } else {
// this.optionalFields = null;
// }
}
/**
* Check for the optional field {@link #HOSTED_LOCATORS} and return the
* value or null.
*/
Collection readHostedLocators() {
if (this.optionalFields == null || this.optionalFields.isEmpty()) {
return null;
}
Collection hostedLocators = null;
String hostedLocatorsString = this.optionalFields.getProperty(HOSTED_LOCATORS);
if (hostedLocatorsString != null && !hostedLocatorsString.isEmpty()) {
StringTokenizer st = new StringTokenizer(hostedLocatorsString, COMMA_DELIMITER);
hostedLocators = new ArrayList();
while (st.hasMoreTokens()) {
String locatorString = st.nextToken();
if (locatorString != null && !locatorString.isEmpty()) {
hostedLocators.add(locatorString);
}
}
if (hostedLocators.isEmpty()) {
hostedLocators = null;
}
}
return hostedLocators;
}
/**
* Write the value for the optional field {@link #HOSTED_LOCATORS}.
*/
void writeHostedLocators(Collection hostedLocators) {
if (this.optionalFields == null) {
return;
}
if (hostedLocators != null && !hostedLocators.isEmpty()) {
String hostedLocatorsString = asCommaDelimitedString(hostedLocators);
if (hostedLocatorsString != null && !hostedLocatorsString.isEmpty()) {
this.optionalFields.setProperty(HOSTED_LOCATORS, hostedLocatorsString);
}
}
}
int readMcastPort() {
int result = 0;
if (this.optionalFields != null) {
String resultString = this.optionalFields.getProperty(MCAST_PORT);
if (resultString != null && !resultString.isEmpty()) {
result = Integer.parseInt(resultString);
}
}
return result;
}
void writeMcastPort(int mcastPort) {
if (this.optionalFields != null) {
if (mcastPort != 0) {
this.optionalFields.setProperty(MCAST_PORT, Integer.toString(mcastPort));
}
}
}
String readMcastHostAddress() {
String result = null;
if (this.optionalFields != null) {
result = this.optionalFields.getProperty(MCAST_HOST_ADDRESS);
}
return result;
}
void writeMcastHostAddress(String addr) {
if (this.optionalFields != null) {
if (addr != null && !addr.isEmpty()) {
this.optionalFields.setProperty(MCAST_HOST_ADDRESS, addr);
}
}
}
/**
* Writes all optional fields to the DataOutput or null for minimal
* wire footprint.
*
* @throws IOException
*/
void toData(DataOutput out) throws IOException {
if (this.optionalFields.isEmpty()) {
DataSerializer.writeObject(null, out);
} else {
DataSerializer.writeObject(this.optionalFields, out);
}
}
/**
* Returns {@link #optionalFields} for testing.
*/
Properties getOptionalFields() {
return this.optionalFields;
}
/**
* Marshals a collection of strings to a single comma-delimited string.
* Returns null if collection is null or empty.
*/
public static String asCommaDelimitedString(Collection strings) {
StringBuilder sb = new StringBuilder();
for (String string : strings) {
if (sb.length() > 0) {
sb.append(COMMA_DELIMITER);
}
sb.append(string);
}
return sb.toString();
}
}