AclWithKey.java

/* Copyright (c) 2008 Google Inc.
 *
 * 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.google.gdata.data.acl;

import com.google.gdata.data.AttributeGenerator;
import com.google.gdata.data.AttributeHelper;
import com.google.gdata.data.ExtensionDescription;
import com.google.gdata.data.ExtensionPoint;
import com.google.gdata.data.ExtensionProfile;
import com.google.gdata.util.ParseException;

/**
 * Describes the key granting a role in an access control list.
 * 
 * 
 */
@ExtensionDescription.Default(
    nsAlias = AclNamespace.gAclAlias,
    nsUri = AclNamespace.gAcl,
    localName = AclWithKey.XML_NAME)
public class AclWithKey extends ExtensionPoint {

  /** XML element name */
  static final String XML_NAME = "withKey";

  /** XML "key" attribute name */
  private static final String KEY = "key";
  
  /** A key granting a role */
  private String key = null;

  /**
   * Default mutable constructor.
   */
  public AclWithKey() {
    super();
  }
  
  /**
   * Immutable constructor.
   * 
   * @param key a key granting a role.
   * @param role a role.
   */
  public AclWithKey(String key, AclRole role) {
    super();
    setKey(key);
    setRole(role);
    setImmutable(true);
  }

  @Override
  public void declareExtensions(ExtensionProfile extProfile) {
    extProfile.declare(AclWithKey.class, AclRole.class);
  }

  /**
   * Returns the key granting a role.
   * 
   * @return a key
   */
  public String getKey() {
    return key;
  }

  /**
   * Sets the key granting a role.
   * 
   * @param key a key or <code>null</code> to reset
   */
  public void setKey(String key) {
    throwExceptionIfImmutable();
    this.key = key;
  }

  /**
   * Returns whether it has a key.
   * 
   * @return whether it has a key
   */
  public boolean hasKey() {
    return getKey() != null;
  }
  
  /**
   * Returns the role.
   * 
   * @return a role
   */
  public AclRole getRole() {
    return getExtension(AclRole.class);
  }
  
  /**
   * Sets the role.
   * 
   * @param role the role or <code>null</code> to reset
   */
  public void setRole(AclRole role) {
    throwExceptionIfImmutable();
    if (role == null) {
      removeExtension(AclRole.class);
    } else {
      setExtension(role);
    }
  }
  
  /**
   * Returns whether it has the role.
   * 
   * @return whether it has the role
   */
  public boolean hasRole() {
    return hasExtension(AclRole.class);
  }

  @Override
  protected void putAttributes(AttributeGenerator generator) {
    generator.put(KEY, key);
  }
  
  @Override
  protected void consumeAttributes(AttributeHelper helper) throws ParseException {
    key = helper.consume(KEY, false);
  }

  @Override
  public String toString() {
    return "{AclWithKey key=" + key + " " + super.toString() + "}";
  }
}