org.glassfish.websocket.api.annotations.WebSocketRemote Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of websocket-api Show documentation
The newest version!
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2011 - 2012 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
 * http://glassfish.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 org.glassfish.websocket.api.annotations;

/**
 * This class level annotation is used to indicate the class is a developer provided custom peer interface (i.e. one that extends
 * Peer) will be used to send a message to the remote client the interface
 * represents. Any methods on the class method may only have one parameter that represents the message
 * to be sent to the client. The type may be String, byte[], any Java primitive type
 * or corresponding Java class. Or the type may be a developer provided type, in which case
 * an encoder class must also be provided.
 * 
For example:

 * 
 *      @WebSocketRemote(

               encoder="wstestbeans.EncodedMessageEncoder")

 * public interface MyCustomClient extends Peer {




           public void sendStringMessage(String message) throws IOException, ConversionException;



       public void sendEncodedMessage(EncodedMessage message) throws IOException, ConversionException;



}
 * 


 * @author dannycoward
 */
public @interface WebSocketRemote {
    /** The fully qualified classname of the encoder
     * to be used to encode the message.
     * @return
     */
    Class[] encoders() default {};
}