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 */
026public class Subscription<T> implements AutoCloseable {
027
028  private final HandlerContainer<T> container;
029  private final T token;
030
031  /**
032   * Constructs a subscription.
033   *
034   * @param token            the token for finding the subscription
035   * @param handlerContainer the container managing handlers
036   */
037  public Subscription(final T token, final HandlerContainer<T> handlerContainer) {
038    this.token = token;
039    this.container = handlerContainer;
040  }
041
042  /**
043   * Gets the token of this subscription.
044   *
045   * @return the token of this subscription
046   */
047  public T getToken() {
048    return token;
049  }
050
051  /**
052   * Unsubscribes this subscription.
053   *
054   * @throws Exception
055   */
056  @Override
057  public void close() throws Exception {
058    container.unsubscribe(this);
059  }
060
061}