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 */
019
020package org.apache.reef.io.network.naming;
021
022import org.apache.reef.io.network.naming.parameters.*;
023import org.apache.reef.tang.formats.ConfigurationModule;
024import org.apache.reef.tang.formats.ConfigurationModuleBuilder;
025import org.apache.reef.tang.formats.OptionalParameter;
026import org.apache.reef.tang.formats.RequiredParameter;
027import org.apache.reef.wake.IdentifierFactory;
028
029/**
030 * Configuration Module Builder for NameResolver.
031 */
032public final class NameResolverConfiguration extends ConfigurationModuleBuilder {
033
034  /**
035   * The port used by name server.
036   */
037  public static final RequiredParameter<Integer> NAME_SERVICE_PORT = new RequiredParameter<>();
038  /**
039   * DNS hostname running the name service.
040   */
041  public static final RequiredParameter<String> NAME_SERVER_HOSTNAME = new RequiredParameter<>();
042
043  /**
044   * Identifier factory for NameClient.
045   */
046  public static final OptionalParameter<IdentifierFactory> IDENTIFIER_FACTORY = new OptionalParameter<>();
047
048  /**
049   * The timeout of caching lookup.
050   */
051  public static final OptionalParameter<Long> CACHE_TIMEOUT = new OptionalParameter<>();
052
053  /**
054   * The timeout of retrying connection.
055   */
056  public static final OptionalParameter<Integer> RETRY_TIMEOUT = new OptionalParameter<>();
057
058  /**
059   * The number of retrying connection.
060   */
061  public static final OptionalParameter<Integer> RETRY_COUNT = new OptionalParameter<>();
062
063  public static final ConfigurationModule CONF = new NameResolverConfiguration()
064      .bindNamedParameter(NameResolverNameServerPort.class, NAME_SERVICE_PORT)
065      .bindNamedParameter(NameResolverNameServerAddr.class, NAME_SERVER_HOSTNAME)
066      .bindNamedParameter(NameResolverIdentifierFactory.class, IDENTIFIER_FACTORY)
067      .bindNamedParameter(NameResolverCacheTimeout.class, CACHE_TIMEOUT)
068      .bindNamedParameter(NameResolverRetryTimeout.class, RETRY_TIMEOUT)
069      .bindNamedParameter(NameResolverRetryCount.class, RETRY_COUNT)
070      .build();
071}