001/* 002 * Copyright 2002-2015 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 021/** 022 * Represents a connected user. 023 * 024 * @author Rossen Stoyanchev 025 * @since 4.2 026 */ 027public interface SimpUser { 028 029 /** 030 * The unique user name. 031 */ 032 String getName(); 033 034 /** 035 * Whether the user has any sessions. 036 */ 037 boolean hasSessions(); 038 039 /** 040 * Look up the session for the given id. 041 * @param sessionId the session id 042 * @return the matching session of {@code null}. 043 */ 044 SimpSession getSession(String sessionId); 045 046 /** 047 * Return the sessions for the user. 048 * The returned set is a copy and will never be modified. 049 * @return a set of session ids, or an empty set. 050 */ 051 Set<SimpSession> getSessions(); 052 053}