/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.hadoop.hdfs.web.resources;

import org.apache.hadoop.fs.permission.FsPermission;

/**
 * Permission parameter, use a Short to represent a FsPermission.
 */
public class PermissionParam extends ShortParam {
  /**
   * Parameter name.
   */
  public static final String NAME = "permission";
  /**
   * Default parameter value.
   */
  public static final String DEFAULT = NULL;

  private static final Domain DOMAIN = new Domain(NAME, 8);

  private static final short DEFAULT_PERMISSION = 0755;

  /**
   * @return the default FsPermission.
   */
  public static FsPermission getDefaultFsPermission() {
    return new FsPermission(DEFAULT_PERMISSION);
  }
  
  /**
   * Constructor.
   *
   * @param value
   *     the parameter value.
   */
  public PermissionParam(final FsPermission value) {
    super(DOMAIN, value == null ? null : value.toShort(), null, null);
  }

  /**
   * Constructor.
   *
   * @param str
   *     a string representation of the parameter value.
   */
  public PermissionParam(final String str) {
    super(DOMAIN, DOMAIN.parse(str), (short) 0, (short) 01777);
  }

  @Override
  public String getName() {
    return NAME;
  }

  /**
   * @return the represented FsPermission.
   */
  public FsPermission getFsPermission() {
    final Short v = getValue();
    return new FsPermission(v != null ? v : DEFAULT_PERMISSION);
  }
}