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