public interface ObjectClassDefinition
Modifier and Type | Field and Description |
---|---|
static int |
ALL
Argument for
getAttributeDefinitions(int) . |
static int |
OPTIONAL
Argument for
getAttributeDefinitions(int) . |
static int |
REQUIRED
Argument for
getAttributeDefinitions(int) . |
Modifier and Type | Method and Description |
---|---|
AttributeDefinition[] |
getAttributeDefinitions(int filter)
Return the attribute definitions for this object class.
|
String |
getDescription()
Return a description of this object class.
|
InputStream |
getIcon(int size)
Return an
InputStream object that can be used to create an
icon from. |
String |
getID()
Return the id of this object class.
|
String |
getName()
Return the name of this object class.
|
static final int REQUIRED
getAttributeDefinitions(int)
.
REQUIRED
indicates that only the required definitions are
returned. The value is 1.
static final int OPTIONAL
getAttributeDefinitions(int)
.
OPTIONAL
indicates that only the optional definitions are
returned. The value is 2.
static final int ALL
getAttributeDefinitions(int)
.
ALL
indicates that all the definitions are returned. The value
is -1.
String getName()
String getID()
ObjectDefintion
objects share a global namespace in the
registry. They share this aspect with LDAP/X.500 attributes. In these
standards the OSI Object Identifier (OID) is used to uniquely identify
object classes. If such an OID exists, (which can be requested at several
standard organisations and many companies already have a node in the
tree) it can be returned here. Otherwise, a unique id should be returned
which can be a java class name (reverse domain name) or generated with a
GUID algorithm. Note that all LDAP defined object classes already have an
OID associated. It is strongly advised to define the object classes from
existing LDAP schemes which will give the OID for free. Many such schemes
exist ranging from postal addresses to DHCP parameters.
String getDescription()
AttributeDefinition[] getAttributeDefinitions(int filter)
Return a set of attributes. The filter parameter can distinguish between
ALL
,REQUIRED
or the OPTIONAL
attributes.
filter
- ALL
,REQUIRED
,OPTIONAL
null
if no
attributes are selectedInputStream getIcon(int size) throws IOException
InputStream
object that can be used to create an
icon from.
Indicate the size and return an InputStream
object containing
an icon. The returned icon maybe larger or smaller than the indicated
size.
The icon may depend on the localization.
size
- Requested size of an icon, e.g. a 16x16 pixels icon then size =
16null
IOException
- If the InputStream
cannot be returned.Copyright © 2018 JBoss by Red Hat. All rights reserved.