public interface IPrincipalMetaData
Modifier and Type | Field and Description |
---|---|
static int |
IPRINCIPAL |
static int |
IPRINCIPALSET |
static String |
PARENT_ATTRIBUTE |
static String |
PARENT_NAMESPACE |
Modifier and Type | Method and Description |
---|---|
String[] |
getAttribute(String namespace,
String name)
Generic get method to access additional attributes.
|
String[] |
getAttributeNames(String namespace)
Gets the names of all attributes contained in the given
namespace , or null if that namespace does not
exist. |
String[] |
getAttributeNamespaces()
Gets all non-null namespaces defined for this user.
|
String |
getAttributeType(String namespace,
String attributeName)
Gets the type of the attribute.
|
byte[] |
getBinaryAttribute(String namespace,
String name)
Generic get method to access additional attributes.
|
String |
getDescription(Locale locale)
Returns the title of the IPrincipal object which is described by this
IPrincipalMetaData object.
|
int |
getPrincipalType()
Gets the semantic type of the described IPrincipal object, e.g.
|
String |
getPrincipalTypeIdentifier()
Gets the
principal type
identifier of the described IPrincipal object. |
String |
getTitle(Locale locale)
Returns the title of the IPrincipal object which is described by this
IPrincipalMetaData object.
|
boolean |
setAttribute(String namespace,
String name,
String[] values)
Generic method to associate arbitrary text data with a IPrincipalMetaData
object.
|
boolean |
setBinaryAttribute(String namespace,
String name,
byte[] value)
Generic method to associate arbitrary binary data with a
IPrincipalMetaData object.
|
void |
setDescription(String description,
Locale locale)
Sets the description for the given locale.
|
void |
setTitle(String title,
Locale locale)
Sets the title for the given locale.
|
static final int IPRINCIPAL
static final int IPRINCIPALSET
static final String PARENT_NAMESPACE
static final String PARENT_ATTRIBUTE
String getTitle(Locale locale)
locale
- the localeString getDescription(Locale locale)
locale
- the localevoid setTitle(String title, Locale locale)
title
- the title or nulllocale
- the localevoid setDescription(String description, Locale locale)
description
- the description or nulllocale
- the localeString getPrincipalTypeIdentifier()
principal type
identifier
of the described IPrincipal object. For details about the
principal type identifier see
IPrincipalFactory.newPrincipal(String)
principal type
identifier
int getPrincipalType()
boolean setAttribute(String namespace, String name, String[] values)
true
if values
is different from the attribute's previous values, false
otherwise. Namespace and name can have up to 255 characters. Each value
can have up to 255 characters.namespace
- namespace of the attribute to set (max. 255 characters).name
- name of the attribute (max. 255 characters)values
- values of the attribute (each max. 255 characters)values
is different from the attribute's
previous values, false otherwiseUMRuntimeException
- if either namespace
or
name
is not supportedboolean setBinaryAttribute(String namespace, String name, byte[] value)
true
if
values
is different from the attribute's previous values,
false
otherwise. Namespace and name can have up to 255
characters.namespace
- namespace of the attribute to set (max. 255 characters).name
- name of the attribute (max. 255 characters)value
- byte array of values of the attributevalues
is different from the attribute's
previous values, false otherwiseUMRuntimeException
- if either namespace
or
name
is not supportedString getAttributeType(String namespace, String attributeName)
IPrincipal.STRING_TYPE
if
the attribute has the type String, or IPrincipal.BYTE_TYPE
if it
is a binary attribute. Returns null if the attribute is not available.namespace
- namespace the attribute is inattributeName
- the name of the attributeString[] getAttributeNames(String namespace)
namespace
, or null
if that namespace does not
exist. If namespace
does exists but contains no attributes,
an empty array will be returned. To retrieve the names of all attributes
that are in no distinct namespace, call this method with the parameter
null
namespace
- namespace or null
namespace
or null
String[] getAttributeNamespaces()
null
exists, it is not
returned as an element in the array. Applications which need to access
the namespace null
must check for its existence and the
contained attributes explicitly via getAttributeNames(null)
.String[] getAttribute(String namespace, String name)
null
. Each attribute can have multiple String
values.namespace
- namespace the attribute is in (may be null
)name
- name of the attributenull
if
this namespace or attribute within this namespace does not existbyte[] getBinaryAttribute(String namespace, String name)
null
.namespace
- namespace the attribute is in (may be null
)name
- name of the attributenull
if
this namespace or attribute within this namespace does not existAccess Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] CORE-TOOLS
|
[sap.com]
|
default
|
BC-JAS
|
[sap.com] ENGFACADE
|
[sap.com] tc/je/usermanagement/api
|
api
|
BC-JAS-SEC
|
[sap.com] ENGINEAPI
|
[sap.com]
|
-
|
BC-JAS-SEC-UME
|
[sap.com] ENGINEAPI
|
[sap.com]
|
default
|
BC-JAS-SEC-UME
|
Copyright 2018 SAP AG Complete Copyright Notice