/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.grizzly.cometd.bayeux;
import java.util.ArrayList;
/**
* Bayeux Handshake implementation.
* See http://svn.xantus.org/shortbus/trunk/bayeux/protocol.txt for the technical
* details.
*
* This is an example of the messages exchanged during a
* connection setup process:
*
* // from client, to server
* [
* {
* "channel": "/meta/handshake",
* // all meta channel messages MUST contain the protocol version the
* // client expects
* "version": 0.1,
* // the oldest version of the protocol that this client will support
* "minimumVersion": 0.1,
* "supportedConnectionTypes": ["iframe", "flash", "http-polling"],
* // the authScheme is outside the realm of this specification and
* // provided here for illustration only. It's also optional.
* "authScheme": "SHA1",
* // the authUser and authToken are optional and authScheme dependent
* "authUser": "alex",
* "authToken": "HASHJIBBERISH"
* }
* // servers MUST ignore other messages in the envelope should the first
* // be a handshake request
* ]
*
* // from server, to client
* [
* {
* "channel": "/meta/handshake",
* // preferred protocol version
* "version": 0.1,
* // the oldest version of the protocol that this server will support
* "minimumVersion": 0.1,
* "supportedConnectionTypes": ["iframe", "flash", "http-polling"],
* "clientId": "SOME_UNIQUE_CLIENT_ID",
* "authSuccessful": true,
* // authToken is auth scheme dependent and entirely optional
* "authToken": "SOME_NONCE_THAT_NEEDS_TO_BE_PROVIDED_SUBSEQUENTLY",
* // advice determines the client behavior on errors
* "advice": {
* "reconnect": "retry", // one of "none", "retry", "handshake", "recover"
*
* // transport specializations of the top-level generalized
* // advice
* "transport": {
* "iframe": { },
* "flash": { },
* "http-polling": {
* // delay before reconnecting
* "interval": 5000 // ms
* }
* }
* }
* }
* // servers MUST send only a handshake message in response to a handshake request
* ]
*
* @author Jeanfrancois Arcand
*/
public class Handshake extends VerbBase{
private String version = "0.1";
private String minimumVersion = "0.1";
private String supportedConnectionTypes
= "[\"long-polling\",\"callback-polling\"]";
private String authScheme="";
private String authUser="";
private String clientId;
private Boolean authSuccessful = Boolean.TRUE;
private Advice advice;
private boolean successfull = true;
public Handshake() {
type = Verb.HANDSHAKE;
}
public String getVersion() {
return version;
}
public void setVersion(String version) {
this.version = version;
}
public String getMinimumVersion() {
return minimumVersion;
}
public void setMinimumVersion(String minimumVersion) {
this.minimumVersion = minimumVersion;
}
public String getSupportedConnectionTypes() {
return supportedConnectionTypes;
}
public void setSupportedConnectionTypes(String supportedConnectionTypes) {
this.supportedConnectionTypes = supportedConnectionTypes;
}
public String getAuthScheme() {
return authScheme;
}
public void setAuthScheme(String authScheme) {
this.authScheme = authScheme;
}
public String getAuthUser() {
return authUser;
}
public void setAuthUser(String authUser) {
this.authUser = authUser;
}
public String getClientId() {
return clientId;
}
public void setClientId(String clientId) {
this.clientId = clientId;
}
public Boolean getAuthSuccessful() {
return authSuccessful;
}
public void setAuthSuccessful(Boolean authSuccessful) {
this.authSuccessful = authSuccessful;
}
public Advice getAdvice() {
return advice;
}
public void setAdvice(Advice advice) {
this.advice = advice;
}
public String toString(){
return toJSON();
}
public String toJSON() {
return "[{"
+ "\"supportedConnectionTypes\":" + supportedConnectionTypes + ","
+ "\"minimumVersion\":" + minimumVersion + ","
+ "\"authSuccessful\":" + authSuccessful + ","
+ ext.toJSON() + ","
+ "\"clientId\":\"" + clientId + "\","
+ "\"successful\":" + successful + ","
+ "\"channel\":\"" + channel + "\","
+ advice.toJSON() + ","
+ "\"version\":" + version
+ "}]\n";
}
}
|
