001/* 002 * Copyright 2002-2017 the original author or authors. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * https://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 */ 016 017package org.springframework.messaging.simp.user; 018 019import java.util.Set; 020 021import org.springframework.lang.Nullable; 022 023/** 024 * Represents a connected user. 025 * 026 * @author Rossen Stoyanchev 027 * @since 4.2 028 */ 029public interface SimpUser { 030 031 /** 032 * The unique user name. 033 */ 034 String getName(); 035 036 /** 037 * Whether the user has any sessions. 038 */ 039 boolean hasSessions(); 040 041 /** 042 * Look up the session for the given id. 043 * @param sessionId the session id 044 * @return the matching session, or {@code null} if none found 045 */ 046 @Nullable 047 SimpSession getSession(String sessionId); 048 049 /** 050 * Return the sessions for the user. 051 * The returned set is a copy and will never be modified. 052 * @return a set of session ids, or an empty set if none 053 */ 054 Set<SimpSession> getSessions(); 055 056}