javax.faces.event.WebsocketEvent Maven / Gradle / Ivy
Show all versions of jakarta.faces-api Show documentation
/*
* Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package javax.faces.event;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.io.Serializable;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import java.util.Objects;
import javax.enterprise.event.Observes;
import javax.faces.push.Push;
import javax.inject.Qualifier;
import javax.websocket.CloseReason.CloseCode;
/**
*
* This web socket event will be fired when a new <f:websocket> has been
* @{@link Opened} or @{@link Closed}. An application scoped CDI bean can
* @{@link Observes} them.
*
* For detailed usage instructions, see @{@link Push} javadoc.
*
* @see Push
* @see Opened
* @see Closed
* @since 2.3
*/
public final class WebsocketEvent implements Serializable {
private static final long serialVersionUID = 1L;
private final String channel;
private final Serializable user;
private final CloseCode code;
public WebsocketEvent(String channel, Serializable user, CloseCode code) {
this.channel = channel;
this.user = user;
this.code = code;
}
/**
* Returns the <f:websocket channel>.
* @return The web socket channel name.
*/
public String getChannel() {
return channel;
}
/**
* Returns the <f:websocket user>, if any.
* @param The generic type of the user identifier.
* @return The web socket user identifier, if any.
* @throws ClassCastException When S is of wrong type.
*/
@SuppressWarnings("unchecked")
public S getUser() {
return (S) user;
}
/**
* Returns the close code.
* If this returns null, then it was {@link Opened}.
* If this returns non-null, then it was {@link Closed}.
* @return The close code.
*/
public CloseCode getCloseCode() {
return code;
}
@Override
public int hashCode() {
return super.hashCode() + Objects.hash(channel, user, code);
}
@Override
public boolean equals(Object other) {
return other != null && getClass() == other.getClass()
&& Objects.equals(channel, ((WebsocketEvent) other).channel)
&& Objects.equals(user, ((WebsocketEvent) other).user)
&& Objects.equals(code, ((WebsocketEvent) other).code);
}
@Override
public String toString() {
return String.format("WebsocketEvent[channel=%s, user=%s, closeCode=%s]", channel, user, code);
}
/**
*
* Indicates that a <f:websocket> has opened.
*
* For detailed usage instructions, see @{@link Push} javadoc.
*
* @see Push
* @since 2.3
*/
@Qualifier
@Target(PARAMETER)
@Retention(RUNTIME)
@Documented
public @interface Opened {
//
}
/**
*
* Indicates that a <f:websocket> has closed.
*
* For detailed usage instructions, see @{@link Push} javadoc.
*
* @see Push
* @since 2.3
*/
@Qualifier
@Target(PARAMETER)
@Retention(RUNTIME)
@Documented
public @interface Closed {
//
}
}