io.undertow.websockets.core.WebSocketVersion Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-client-all

This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up with different versions on classes on the class path).

There is a newer version: 34.0.0.Final

Show newest version

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2014 Red Hat, Inc., and individual contributors
 * as indicated by the @author tags.
 *
 * 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.
 */

package io.undertow.websockets.core;


import io.undertow.util.AttachmentKey;

/**
 * 
 * Enum which list all the different versions of the WebSocket specification (to the current date).
 * 
 * 
 * A specification is tied to one wire protocol version but a protocol version may have use by more than 1 version of
 * the specification.
 * 
 *
 * @author Norman Maurer
 */
public enum WebSocketVersion {

    /**
     * Unknown version of the protocol
     */
    UNKNOWN,

    /**
     * draft-ietf-hybi-thewebsocketprotocol- 00.
     */
    V00,

    /**
     * draft-ietf-hybi-thewebsocketprotocol- 07
     */
    V07,

    /**
     * draft-ietf-hybi-thewebsocketprotocol- 10
     */
    V08,

    /**
     * RFC 6455. This was originally draft-ietf-hybi-thewebsocketprotocol-
     * 17
     */
    V13;

    /**
     * Returns a {@link String} representation of the {@link WebSocketVersion} that can be used in the HTTP Headers.
     */
    public String toHttpHeaderValue() {
        if (this == V00) {
            return "0";
        }
        if (this == V07) {
            return "7";
        }
        if (this == V08) {
            return "8";
        }
        if (this == V13) {
            return "13";
        }
        // Should never hit here.
        throw new IllegalStateException("Unknown WebSocket version: " + this);
    }


    public static final AttachmentKey ATTACHMENT_KEY = AttachmentKey.create(WebSocketVersion.class);
}