StartSessionMsg.java revision d25372dc8e65a9ed019a88fdf659ca61313f1b31
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at
* trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
* add the following below this CDDL HEADER, with the fields enclosed
* by brackets "[]" replaced with your own identifying information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
*
* Copyright 2008 Sun Microsystems, Inc.
*/
/**
* This message is used by DS to confirm a RS he wants to connect to him (open
* a session):
* Handshake sequence between DS and RS is like this:
* DS --- ServerStartMsg ---> RS
* DS <--- ReplServerStartMsg --- RS
* DS --- StartSessionMsg ---> RS
* DS <--- TopologyMsg --- RS
*
* This message contains:
* - status: the status we are entering the topology with
* - referrals URLs: the referrals URLs we allow peer DSs to use to refer to
* our domain when needed.
*/
public class StartSessionMsg extends ReplicationMsg
{
// The list of referrals URLs to the sending DS
// The initial status the DS starts with
// Assured replication enabled on DS or not
private boolean assuredFlag = false;
// DS assured mode (relevant if assured replication enabled)
// DS safe data level (relevant if assured mode is safe data)
private byte safeDataLevel = (byte) 1;
/**
* Creates a new StartSessionMsg message from its encoded form.
*
* @param in The byte array containing the encoded form of the message.
* @throws java.util.zip.DataFormatException If the byte array does not
* contain a valid encoded form of the message.
*/
{
/*
* The message is stored in the form:
* <message type><status><assured flag><assured mode><safe data level>
* <list of referrals urls>
* (each referral url terminates with 0)
*/
try
{
/* first byte is the type */
{
throw new DataFormatException(
}
/* Read the status */
/* Read the assured flag */
{
assuredFlag = true;
} else
{
assuredFlag = false;
}
/* Read the assured mode */
/* Read the safe data level */
/* Read the refferals URLs */
int pos = 5;
{
/*
* Read the next URL
* first calculate the length then construct the string
*/
}
} catch (UnsupportedEncodingException e)
{
throw new DataFormatException("UTF-8 is not supported by this jvm.");
} catch (IllegalArgumentException e)
{
throw new DataFormatException(e.getMessage());
}
}
/**
* Creates a new StartSessionMsg message with the given required parameters.
* @param status Status we are starting with
* @param referralsURLs Referrals URLs to be used by peer DSs
* @param assuredFlag If assured mode is enabled or not
* @param assuredMode Assured type
* @param safeDataLevel Assured mode safe data level
*/
{
this.referralsURLs = referralsURLs;
this.assuredFlag = assuredFlag;
this.assuredMode = assuredMode;
this.safeDataLevel = safeDataLevel;
}
/**
* Creates a new StartSessionMsg message with the given required parameters.
* Assured mode is false.
* @param status Status we are starting with
* @param referralsURLs Referrals URLs to be used by peer DSs
*/
{
this.referralsURLs = referralsURLs;
this.assuredFlag = false;
}
/**
* {@inheritDoc}
*/
public byte[] getBytes()
{
/*
* The message is stored in the form:
* <message type><status><assured flag><assured mode><safe data level>
* <list of referrals urls>
* (each referral url terminates with 0)
*/
try
{
/* Put the message type */
// Put the status
// Put the assured flag
// Put assured mode
// Put safe data level
// Put the referrals URLs
{
{
}
}
return oStream.toByteArray();
} catch (IOException e)
{
// never happens
return null;
}
}
/**
* Get the list of referrals URLs.
*
* @return The list of referrals URLs.
*/
{
return referralsURLs;
}
/**
* Get the status from this message.
* @return The status.
*/
public ServerStatus getStatus()
{
return status;
}
/**
* {@inheritDoc}
*/
{
for (String s : referralsURLs)
{
urls += s + " | ";
}
return ("StartSessionMsg content:\nstatus: " + status +
"\nassuredFlag: " + assuredFlag +
"\nassuredMode: " + assuredMode +
"\nsafeDataLevel: " + safeDataLevel +
"\nreferralsURLs: " + urls);
}
/**
* Returns true if assured mode is enabled.
* @return true if assured mode is enabled.
*/
public boolean isAssured()
{
return assuredFlag;
}
/**
* Get the assured mode.
* @return the assured mode.
*/
public AssuredMode getAssuredMode()
{
return assuredMode;
}
/**
* Get the safe data level.
* @return the safe data level.
*/
public byte getSafeDataLevel()
{
return safeDataLevel;
}
}