com.sun.grizzly.cometd.bayeux.Connect Maven / Gradle / Ivy
The newest version!
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2007-2010 Oracle and/or its affiliates. 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_1_1.html
* or packager/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 packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [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;
/**
* Bayeux Connect implementation.
* See http://svn.xantus.org/shortbus/trunk/bayeux/protocol.txt for the technical
* details.
*
* // here's what the client then POST's:
*
* //-----------------
* // CLIENT -> SERVER
* //-----------------
* [
* {
* "channel": "/meta/connect",
* "clientId": "SOME_UNIQUE_CLIENT_ID",
* "connectionType": "iframe",
* // optional
* "authToken":"SOME_NONCE_PREVIOUSLY_PROVIDED_BY_SERVER"
* }
* // , ...
* ]
*
* // NOTE: data should be POSTed with an encoding of
* // application/x-www-form-urlencoded, and the preceeding payload is
* // expected to be stored in the "message" parameter
*
* // the server now replies with the preamble followed by any number of
* // messages encoded in the tunnel-specific envelope:
*
* //-----------------
* // SERVER -> CLIENT
* //-----------------
*
*
*
*
* Comet -- cleaning up web development
*
*
*
*
*
*
*
*
* ...
*
*
*
*
*
*
* @author Jeanfrancois Arcand
*/
abstract public class Connect extends VerbBase{
public final static String HTML_HEADER =
"" +
"\n\nGrizzly Cometd " +
"\n\n\n\n\n\n
\n\n\n";
public final static String META_CONNECT ="/meta/connect";
protected String connectionType;
public Connect() {
type = Verb.Type.CONNECT;
metaChannel = META_CONNECT;
}
@Override
public boolean isValid() {
return (clientId != null && getMetaChannel().equals(getChannel()));
}
}