org.gluu.oxtrust.model.scim2.extensions.ExtensionField クラス

org.gluu.oxtrust.model.scim2.extensions.ExtensionField 連携図

公開メンバ関数
Type	getAttributeDefinitionType ()
String	getName ()
void	setName (String name)
boolean	isMultiValued ()
AttributeDataType	getType ()
void	setMultiValued (boolean multiValued)
void	setType (AttributeDataType type)
String	getDescription ()
void	setDescription (String description)

静的公開メンバ関数
static Object	valueOf (ExtensionField field, Object val)
static Object	valueFromString (ExtensionField field, String val)
static String	stringValueOf (ExtensionField field, Object val)

非公開変数類
String	name
boolean	multiValued
AttributeDataType	type
String	description

静的非公開変数類
static final String	XSD_DATE_TIME_PATTERN ="^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.*$"

詳解

Represents the metadata of an attribute that belongs to a SCIM resource extension.

Attributes part of extensions, aka "extended attributes" or "custom attributes" have implicit characteristics equal to the defaults shown in section 2.2 of RFC 7643. In other words, all custom attributes have:

• canonicalValues: none assigned
• required: false
• caseExact: false
• mutability: readWrite
• returned: default
• uniqueness: none
• referenceTypes: none

The only "configurable" characteristics supported are:

• multivalued: true/false
• type: reference, string, datetime, decimal, and boolean (only).

These can be tweaked via oxTrust admin web console.

See also: Extension class.

関数詳解

getAttributeDefinitionType()

Type org.gluu.oxtrust.model.scim2.extensions.ExtensionField.getAttributeDefinitionType ( )

inline

Maps the org.xdi.model.GluuAttributeDataType associated to this ExtensionField (see getType) to a member of the enum AttributeDefinition.Type.

The mapping is straightforward. Special case is org.xdi.model.GluuAttributeDataType.NUMERIC mapped to Type.DECIMAL.

戻り値

An enum value of AttributeDefinition.Type

                                            {

        Type attrType=null;
        switch (type) {
            case BINARY:
                attrType = Type.BINARY;
                break;
            case STRING:
                attrType = Type.STRING;
                break;
            case DATE:
                attrType = Type.DATETIME;
                break;
            case NUMERIC:
                attrType = Type.DECIMAL; //Return the broader of DECIMAL or INTEGER;
                break;
            case BOOLEAN:
                attrType = Type.BOOLEAN;
                break;
        }
        return attrType;

    }

getDescription()

String org.gluu.oxtrust.model.scim2.extensions.ExtensionField.getDescription ( )

inline

                                   {
        return description;
    }

getName()

String org.gluu.oxtrust.model.scim2.extensions.ExtensionField.getName ( )

inline

                            {
        return name;
    }

getType()

AttributeDataType org.gluu.oxtrust.model.scim2.extensions.ExtensionField.getType ( )

inline

                                       {
        return type;
    }

isMultiValued()

boolean org.gluu.oxtrust.model.scim2.extensions.ExtensionField.isMultiValued ( )

inline

                                   {
        return multiValued;
    }

setDescription()

void org.gluu.oxtrust.model.scim2.extensions.ExtensionField.setDescription ( String  description )

inline

                                                   {
        this.description = description;
    }

setMultiValued()

void org.gluu.oxtrust.model.scim2.extensions.ExtensionField.setMultiValued ( boolean  multiValued )

inline

                                                    {
        this.multiValued = multiValued;
    }

setName()

void org.gluu.oxtrust.model.scim2.extensions.ExtensionField.setName ( String  name )

inline

                                     {
        this.name = name;
    }

setType()

void org.gluu.oxtrust.model.scim2.extensions.ExtensionField.setType ( AttributeDataType  type )

inline

                                                {
        this.type = type;
    }

stringValueOf()

static String org.gluu.oxtrust.model.scim2.extensions.ExtensionField.stringValueOf ( ExtensionField  field, Object  val  )

inlinestatic

Takes an object and a ExtensionField, and returns a String (suitable for storing in LDAP). For a field data type NUMERIC, BOOLEAN or STRING, a straight string representation is returned. When it's DATE, it is converted from ISO to generalized date time format.

引数

field	An instance of ExtensionField
val	A value

戻り値

String formated properly

                                                                        {

        String value=null;
        switch (field.getType()) {
            case NUMERIC:
            case STRING:
            case BINARY:
                value=val.toString();
                break;
            case DATE:
                value=DateUtil.ISOToGeneralizedStringDate(val.toString());
                break;
            case BOOLEAN:
                value=val.toString().toUpperCase(); //LDAP accepts TRUE or FALSE only
                break;
        }
        return value;

    }

valueFromString()

static Object org.gluu.oxtrust.model.scim2.extensions.ExtensionField.valueFromString ( ExtensionField  field, String  val  )

inlinestatic

Equivalent to valueOf, however, a String is supplied as value. Here no validations on data type consistence takes place (it is expected that value passed reflects the type of the field). If the field is a DATE, a conversion from ISO format is done, nonetheless, DATE fields still remain being represented as Java strings

引数

field	An ExtensionField
val	A non-null String value

戻り値

A value

                                                                          {

        Object value=null;  //In practice value will never end up being null
        switch (field.getType()){
            case STRING:
            case BINARY:
                value = val;
                break;
            case DATE:
                //Dates are stored and read as strings indeed (no handling of Date or DateTime objects)
                value=DateUtil.generalizedToISOStringDate(val);
                break;
            case NUMERIC:
                try{
                    value = new Integer(val);
                }
                catch (Exception e){
                    try{
                        value = new Double(val);
                    }
                    catch (Exception e2) {
                        value = null;
                    }
                }
                break;
            case BOOLEAN:
                value=Boolean.valueOf(val);
                break;
        }
        return value;

    }

valueOf()

static Object org.gluu.oxtrust.model.scim2.extensions.ExtensionField.valueOf ( ExtensionField  field, Object  val  )

inlinestatic

Tries parsing the value passed according to the data type associated to the field

引数

field	An ExtensionField instance that determines the data type expected to be received
val	A non-null object that represents a (hopefully valid) value for this field

戻り値

Null if the value is not consistent with the data type expected. Otherwise, the same value received is returned

                                                                  {

        Object value=null;
        switch (field.getType()){
            case STRING:
            case BINARY:
                if (val instanceof String)
                    value = val;
                break;
            case DATE:
                //Dates are stored and read as strings indeed (no usage of Date-related classes take place)
                if (val instanceof String) {
                    Pattern p = Pattern.compile(XSD_DATE_TIME_PATTERN);
                    if (p.matcher(val.toString()).find())
                        value=val;
                }
                break;
            case NUMERIC:
                if (val instanceof Integer || val instanceof Double)
                    value = val;
                break;
            case BOOLEAN:
                if (val instanceof Boolean)
                    value = val;
                break;
        }
        return value;

    }

メンバ詳解

description

String org.gluu.oxtrust.model.scim2.extensions.ExtensionField.description

private

multiValued

boolean org.gluu.oxtrust.model.scim2.extensions.ExtensionField.multiValued

private

name

String org.gluu.oxtrust.model.scim2.extensions.ExtensionField.name

private

type

AttributeDataType org.gluu.oxtrust.model.scim2.extensions.ExtensionField.type

private

XSD_DATE_TIME_PATTERN

final String org.gluu.oxtrust.model.scim2.extensions.ExtensionField.XSD_DATE_TIME_PATTERN ="^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.*$"

staticprivate

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/OpenId/gluu/src/oxTrust/scim/src/main/java/org/gluu/oxtrust/model/scim2/extensions/ExtensionField.java