com.linkedin.restli.server.RestLiConfig Maven / Gradle / Ivy

Go to download
/*
   Copyright (c) 2012 LinkedIn Corp.

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
*/

package com.linkedin.restli.server;


import com.linkedin.restli.internal.server.methods.response.ErrorResponseBuilder;

import java.net.URI;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;


/**
 * Configuration for rest.li servers.
 *
 * @author dellamag
 */
public class RestLiConfig
{
  public static enum RestliProtocolCheck
  {
    /**
     * Check that the client supplied protocol version lies between
     * {@link com.linkedin.restli.internal.common.AllProtocolVersions#BASELINE_PROTOCOL_VERSION} and
     * {@link com.linkedin.restli.internal.common.AllProtocolVersions#NEXT_PROTOCOL_VERSION}.
     */
    RELAXED,

    /**
     * Check that the client supplied protocol version lies between
     * {@link com.linkedin.restli.internal.common.AllProtocolVersions#BASELINE_PROTOCOL_VERSION} and
     * {@link com.linkedin.restli.internal.common.AllProtocolVersions#LATEST_PROTOCOL_VERSION}.
     */
    STRICT;
  }

  private final Set _resourcePackageNames = new HashSet();
  private final Set _resourceClassNames = new HashSet();
  private URI _serverNodeUri = URI.create("");
  private RestLiDocumentationRequestHandler _documentationRequestHandler = null;
  private ErrorResponseFormat _errorResponseFormat = ErrorResponseFormat.FULL;
  private String _internalErrorMessage = ErrorResponseBuilder.DEFAULT_INTERNAL_ERROR_MESSAGE;
  private boolean _permissiveEncoding = false;
  private RestliProtocolCheck _restliProtocolCheck = RestliProtocolCheck.STRICT;
  private List _debugRequestHandlers;

  /**
   * Constructor.
   */
  public RestLiConfig()
  {
    this (Collections.emptyMap());
  }

  /**
   * @param mapConfig not currently used
   */
  public RestLiConfig(final Map mapConfig)
  {
    _debugRequestHandlers = new ArrayList();
  }

  public Set getResourcePackageNamesSet()
  {
    return Collections.unmodifiableSet(_resourcePackageNames);
  }

  public Set getResourceClassNamesSet()
  {
    return Collections.unmodifiableSet(_resourceClassNames);
  }

  /**
   * @param commaDelimitedResourcePackageNames comma-delimited package names list
   */
  public void setResourcePackageNames(final String commaDelimitedResourcePackageNames)
  {
    if (commaDelimitedResourcePackageNames != null &&
        ! "".equals(commaDelimitedResourcePackageNames.trim()))
    {
      _resourcePackageNames.clear();
      addResourcePackageNames(commaDelimitedResourcePackageNames.split(","));
    }
  }

  /**
   * @param packageNames set of package names to be scanned
   */
  public void setResourcePackageNamesSet(final Set packageNames)
  {
    if (packageNames != null && !packageNames.isEmpty())
    {
      _resourcePackageNames.clear();
      _resourcePackageNames.addAll(packageNames);
    }
  }

  /**
   * @param packageNames collection of package names to be scanned
   */
  public void addResourcePackageNames(final Collection packageNames)
  {
    _resourcePackageNames.addAll(packageNames);
  }

  /**
   * @param packageNames array of package names to be scanned
   */
  public void addResourcePackageNames(final String... packageNames)
  {
    _resourcePackageNames.addAll(Arrays.asList(packageNames));
  }

  /**
   * @param classNames set of class names to be loaded
   */
  public void setResourceClassNamesSet(final Set classNames)
  {
    if (classNames != null && !classNames.isEmpty())
    {
      _resourceClassNames.clear();
      _resourceClassNames.addAll(classNames);
    }
  }

  /**
   * @param classNames collection of specific resource class names to be loaded
   */
  public void addResourceClassNames(final Collection classNames)
  {
    _resourceClassNames.addAll(classNames);
  }

  /**
   * @param classNames array of specific resource class names to be loaded
   */
  public void addResourceClassNames(final String... classNames)
  {
    _resourceClassNames.addAll(Arrays.asList(classNames));
  }

  public URI getServerNodeUri()
  {
    return _serverNodeUri;
  }

  public void setServerNodeUri(final URI serverNodeUri)
  {
    _serverNodeUri = serverNodeUri;
  }

  public RestLiDocumentationRequestHandler getDocumentationRequestHandler()
  {
    return _documentationRequestHandler;
  }

  public void setDocumentationRequestHandler(final RestLiDocumentationRequestHandler handler)
  {
    _documentationRequestHandler = handler;
  }

  /**
   * Gets the list of debug request handlers in this Rest.li config.
   * @return the list of debug request handlers.
   */
  public List getDebugRequestHandlers()
  {
    return _debugRequestHandlers;
  }

  /**
   * Adds a number of debug request handlers to this Rest.li config.
   * @param handlers The debug request handlers to add.
   */
  public void addDebugRequestHandlers(final RestLiDebugRequestHandler... handlers)
  {
    _debugRequestHandlers.addAll(Arrays.asList(handlers));
  }

  /**
   * Adds a number of debug request handlers to this Rest.li config.
   * @param handlers The debug request handlers to add.
   */
  public void addDebugRequestHandlers(final Collection handlers)
  {
    _debugRequestHandlers.addAll(handlers);
  }

  /**
   * Sets the list of debug request handlers on this Rest.li config.
   * @param handlers The debug request handlers to set.
   */
  public void setDebugRequestHandlers(final List handlers)
  {
    _debugRequestHandlers = new ArrayList(handlers);
  }

  public ErrorResponseFormat getErrorResponseFormat()
  {
    return _errorResponseFormat;
  }

  public void setErrorResponseFormat(ErrorResponseFormat errorResponseFormat)
  {
    this._errorResponseFormat = errorResponseFormat;
  }

  public String getInternalErrorMessage()
  {
    return _internalErrorMessage;
  }

  public void setInternalErrorMessage(String internalErrorMessage)
  {
    _internalErrorMessage = internalErrorMessage;
  }

  public boolean getPermissiveEncoding()
  {
    return _permissiveEncoding;
  }

  public void setPermissiveEncoding(boolean permissiveEncoding)
  {
    _permissiveEncoding = permissiveEncoding;
  }

  public void setRestliProtocolCheck(RestliProtocolCheck restliProtocolCheck)
  {
    if (restliProtocolCheck == null)
    {
      throw new IllegalArgumentException("Cannot be null!");
    }
    _restliProtocolCheck = restliProtocolCheck;
  }

  public RestliProtocolCheck getRestliProtocolCheck()
  {
    return _restliProtocolCheck;
  }
}