001/* 002 * Copyright 2009-2020 Ping Identity Corporation 003 * All Rights Reserved. 004 */ 005/* 006 * Copyright 2009-2020 Ping Identity Corporation 007 * 008 * Licensed under the Apache License, Version 2.0 (the "License"); 009 * you may not use this file except in compliance with the License. 010 * You may obtain a copy of the License at 011 * 012 * http://www.apache.org/licenses/LICENSE-2.0 013 * 014 * Unless required by applicable law or agreed to in writing, software 015 * distributed under the License is distributed on an "AS IS" BASIS, 016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 017 * See the License for the specific language governing permissions and 018 * limitations under the License. 019 */ 020/* 021 * Copyright (C) 2009-2020 Ping Identity Corporation 022 * 023 * This program is free software; you can redistribute it and/or modify 024 * it under the terms of the GNU General Public License (GPLv2 only) 025 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only) 026 * as published by the Free Software Foundation. 027 * 028 * This program is distributed in the hope that it will be useful, 029 * but WITHOUT ANY WARRANTY; without even the implied warranty of 030 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 031 * GNU General Public License for more details. 032 * 033 * You should have received a copy of the GNU General Public License 034 * along with this program; if not, see <http://www.gnu.org/licenses>. 035 */ 036package com.unboundid.ldap.sdk.persist; 037 038 039 040import java.io.Serializable; 041 042import com.unboundid.util.Extensible; 043import com.unboundid.util.ThreadSafety; 044import com.unboundid.util.ThreadSafetyLevel; 045 046 047 048/** 049 * This class provides a mechanism that can be used for generating object 050 * identifiers (OIDs) for use in attribute type and object class definitions 051 * constructed for use in representing an object in the directory. 052 * <BR><BR> 053 * Note that OIDs generated are not necessarily required to be valid, nor are 054 * they required to be unique. As such, OIDs included in generated attribute 055 * type and object class definitions may need to be edited before the 056 * definitions can be added to the directory server. 057 */ 058@Extensible() 059@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE) 060public abstract class OIDAllocator 061 implements Serializable 062{ 063 /** 064 * The serial version UID for this serializable class. 065 */ 066 private static final long serialVersionUID = -2031217984148568974L; 067 068 069 070 /** 071 * Allocates an OID for the attribute type with the specified name. 072 * 073 * @param name The name of the attribute type for which to generate an OID. 074 * It must not be {@code null} or empty. 075 * 076 * @return The OID to use for the attribute type definition. 077 */ 078 public abstract String allocateAttributeTypeOID(String name); 079 080 081 082 /** 083 * Allocates an OID for the object class with the specified name. 084 * 085 * @param name The name of the object class for which to generate an OID. 086 * It must not be {@code null} or empty. 087 * 088 * @return The OID to use for the object class definition. 089 */ 090 public abstract String allocateObjectClassOID(String name); 091}