001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2006-2008 Sun Microsystems, Inc.
025 *      Portions Copyright 2012-2015 ForgeRock AS
026 */
027package org.opends.server.schema;
028
029import static org.opends.server.schema.SchemaConstants.*;
030
031import org.forgerock.opendj.ldap.schema.Schema;
032import org.forgerock.opendj.ldap.schema.Syntax;
033import org.opends.server.admin.std.server.AttributeSyntaxCfg;
034import org.opends.server.api.AttributeSyntax;
035
036/**
037 * This class implements the name and optional UID attribute syntax, which holds
038 * values consisting of a DN, optionally followed by an octothorpe (#) and a bit
039 * string value.
040 */
041public class NameAndOptionalUIDSyntax
042       extends AttributeSyntax<AttributeSyntaxCfg>
043{
044  /**
045   * Creates a new instance of this syntax.  Note that the only thing that
046   * should be done here is to invoke the default constructor for the
047   * superclass.  All initialization should be performed in the
048   * <CODE>initializeSyntax</CODE> method.
049   */
050  public NameAndOptionalUIDSyntax()
051  {
052    super();
053  }
054
055  /** {@inheritDoc} */
056  @Override
057  public Syntax getSDKSyntax(Schema schema)
058  {
059    return schema.getSyntax(SchemaConstants.SYNTAX_NAME_AND_OPTIONAL_UID_OID);
060  }
061
062  /**
063   * Retrieves the common name for this attribute syntax.
064   *
065   * @return  The common name for this attribute syntax.
066   */
067  @Override
068  public String getName()
069  {
070    return SYNTAX_NAME_AND_OPTIONAL_UID_NAME;
071  }
072
073  /**
074   * Retrieves the OID for this attribute syntax.
075   *
076   * @return  The OID for this attribute syntax.
077   */
078  @Override
079  public String getOID()
080  {
081    return SYNTAX_NAME_AND_OPTIONAL_UID_OID;
082  }
083
084  /**
085   * Retrieves a description for this attribute syntax.
086   *
087   * @return  A description for this attribute syntax.
088   */
089  @Override
090  public String getDescription()
091  {
092    return SYNTAX_NAME_AND_OPTIONAL_UID_DESCRIPTION;
093  }
094}
095