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
019/**
020 * Represents a subscription within a user session.
021 *
022 * @author Rossen Stoyanchev
023 * @since 4.2
024 */
025public interface SimpSubscription {
026
027        /**
028         * Return the id associated of the subscription, never {@code null}.
029         */
030        String getId();
031
032        /**
033         * Return the session of the subscription, never {@code null}.
034         */
035        SimpSession getSession();
036
037        /**
038         * Return the subscription's destination, never {@code null}.
039         */
040        String getDestination();
041
042}