Source code

001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.reef.wake.remote.impl;
020
021/**
022 * Subscription of a handler.
023 *
024 * @param <T> type
025 * @deprecated [REEF-1544] Prefer using SubscriptionHandler and the corresponding handlers
026 * instead of the Subscription class. Remove class after release 0.16.
027 */
028public class Subscription<T> implements AutoCloseable {
029
030  private final HandlerContainer<T> container;
031  private final T token;
032
033  /**
034   * Constructs a subscription.
035   *
036   * @param token            the token for finding the subscription
037   * @param handlerContainer the container managing handlers
038   */
039  public Subscription(final T token, final HandlerContainer<T> handlerContainer) {
040    this.token = token;
041    this.container = handlerContainer;
042  }
043
044  /**
045   * Gets the token of this subscription.
046   *
047   * @return the token of this subscription
048   */
049  public T getToken() {
050    return token;
051  }
052
053  /**
054   * Unsubscribes this subscription.
055   *
056   * @throws Exception
057   */
058  @Override
059  public void close() throws Exception {
060    container.unsubscribe(this);
061  }
062
063}