org.omnifaces.cdi.push.SocketEvent Maven / Gradle / Ivy
Show all versions of omnifaces Show documentation
/*
* Copyright OmniFaces
*
* 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
*
* https://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 org.omnifaces.cdi.push;
import static java.lang.String.format;
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 jakarta.enterprise.event.Observes;
import jakarta.enterprise.util.AnnotationLiteral;
import jakarta.inject.Qualifier;
import jakarta.websocket.CloseReason.CloseCode;
/**
*
* This web socket event will be fired by {@link SocketSessionManager} when a socket has been
* @{@link Opened}, @{@link Switched} or @{@link Closed}.
* An application scoped CDI bean can @{@link Observes} them.
*
* For detailed usage instructions, see {@link Socket} javadoc.
*
* @author Bauke Scholtz
* @see Socket
* @since 2.3
*/
public final class SocketEvent implements Serializable {
private static final long serialVersionUID = 1L;
private final String channel;
private final Serializable user;
private final Serializable previousUser;
private final CloseCode code;
SocketEvent(String channel, Serializable user, Serializable previousUser, CloseCode code) {
this.channel = channel;
this.user = user;
this.previousUser = previousUser;
this.code = code;
}
/**
* Returns the <o:socket channel>.
* @return The web socket channel name.
*/
public String getChannel() {
return channel;
}
/**
* Returns the current <o:socket user>, if any.
* @param The generic type of the user identifier.
* @return The current web socket user identifier, if any.
* @throws ClassCastException When S is of wrong type.
*/
@SuppressWarnings("unchecked")
public S getUser() {
return (S) user;
}
/**
* Returns the previous <o:socket user>, if any.
* @param The generic type of the user identifier.
* @return The previous web socket user identifier, if any.
* @throws ClassCastException When S is of wrong type.
* @since 3.2
*/
@SuppressWarnings("unchecked")
public S getPreviousUser() {
return (S) previousUser;
}
/**
* 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 object) {
if (object == null || getClass() != object.getClass()) {
return false;
}
SocketEvent other = (SocketEvent) object;
return Objects.equals(channel, other.channel)
&& Objects.equals(user, other.user)
&& Objects.equals(code, other.code);
}
@Override
public String toString() {
return format("SocketEvent[channel=%s, user=%s, closeCode=%s]", channel, user, code);
}
/**
*
* Indicates that a socket has opened.
*
* For detailed usage instructions, see {@link Socket} javadoc.
*
* @author Bauke Scholtz
* @see Socket
* @since 2.3
*/
@Qualifier
@Target(PARAMETER)
@Retention(RUNTIME)
@Documented
public @interface Opened {
/**
* The literal of {@link Opened}.
* @since 3.2
*/
public static final AnnotationLiteral LITERAL = new AnnotationLiteral() {
private static final long serialVersionUID = 1L;
};
}
/**
*
* Indicates that a socket user was switched.
*
* For detailed usage instructions, see {@link Socket} javadoc.
*
* @author Bauke Scholtz
* @see Socket
* @since 3.2
*/
@Qualifier
@Target(PARAMETER)
@Retention(RUNTIME)
@Documented
public @interface Switched {
/**
* The literal of {@link Switched}.
*/
public static final AnnotationLiteral LITERAL = new AnnotationLiteral() {
private static final long serialVersionUID = 1L;
};
}
/**
*
* Indicates that a socket has closed.
*
* For detailed usage instructions, see {@link Socket} javadoc.
*
* @author Bauke Scholtz
* @see Socket
* @since 2.3
*/
@Qualifier
@Target(PARAMETER)
@Retention(RUNTIME)
@Documented
public @interface Closed {
/**
* The literal of {@link Closed}.
* @since 3.2
*/
public static final AnnotationLiteral LITERAL = new AnnotationLiteral() {
private static final long serialVersionUID = 1L;
};
}
}