org.gluu.oxtrust.model.scim2.CustomAttributes クラス

org.gluu.oxtrust.model.scim2.CustomAttributes 連携図

公開メンバ関数
	CustomAttributes (String uri)
String	getUri ()
Set< String >	getAttributeNames ()
void	remove (String name)
void	setAttribute (String name, String value)
void	setAttribute (String name, Boolean value)
void	setAttribute (String name, Double value)
void	setAttribute (String name, Integer value)
void	setAttribute (String name, DateTime value)
void	setAttribute (String name, Date value)
void	setAttribute (String name, List<?> values)

関数
	CustomAttributes (String uri, Map< String, Object > attributeMap)
Map< String, Object >	getAttributeMap ()
public< T > List< T >	getValues (String name, Class< T > cls)
public< T > T	getValue (String name, Class< T > cls)

非公開メンバ関数
void	set (String name, Object value)

静的非公開メンバ関数
static< T > T	getTypedValue (Object val, Class< T > cls)

非公開変数類
Map< String, Object >	attributeMap
String	uri

詳解

A class used to store the values of custom attributes associated to a resource extension. This class is mainly targeted at users of Java SCIM-Client in order to specify/retrieve custom attributes.

Use the setAttribute methods to associate one (or several) values to an attribute, and use the getValue/getValues methods to retrive those values when coming directly from service invocations.

For both kind of operations (set/get) the data types used should ideally be consistent with the previously configured custom attributes at Gluu Server. This allows your custom data to be successfully validated when sent to server, or to be correctly retrieved when reading a response.

For photo or text, you may use String, for numeric sensible choices are Integer or Double, for boolean use Boolean, and for date you may use Date or DateTime from Joda-Time library.

Remember that custom attributes can be managed via Gluu Server oxTrust admin web console. For instructions, please see the SCIM docs page.

See also: BaseScimResource#addCustomAttributes(CustomAttributes) and BaseScimResource#getCustomAttributes(String).

構築子と解体子

CustomAttributes() [1/2]

org.gluu.oxtrust.model.scim2.CustomAttributes.CustomAttributes ( String  uri )

inline

Constructs an instance of this class to store the attribute values associated to an extension whose URI is supplied.

引数

uri	A string denoting the URI of an existing extension

                                       {
        this.uri=uri;
        attributeMap=new HashMap<String, Object>();
    }

CustomAttributes() [2/2]

org.gluu.oxtrust.model.scim2.CustomAttributes.CustomAttributes ( String  uri, Map< String, Object >  attributeMap  )

inlinepackage

                                                                  {
        this.uri=uri;
        this.attributeMap=attributeMap;

    }

関数詳解

getAttributeMap()

Map<String, Object> org.gluu.oxtrust.model.scim2.CustomAttributes.getAttributeMap ( )

inlinepackage

                                          {
        return attributeMap;
    }

getAttributeNames()

Set<String> org.gluu.oxtrust.model.scim2.CustomAttributes.getAttributeNames ( )

inline

Returns the names of all attributes currently part of this instance object.

戻り値

A Set of Strings

                                          {
        return attributeMap.keySet();
    }

getTypedValue()

static <T> T org.gluu.oxtrust.model.scim2.CustomAttributes.getTypedValue ( Object  val, Class< T >  cls  )

inlinestaticprivate

                                                                {

        if (val!=null) {
            Class classOfVal=val.getClass();

            if (IntrospectUtil.isCollection(classOfVal)){
                //Return only the 1st
                Collection coll=(Collection) val;
                Iterator<?> iterator=coll.iterator();
                if (iterator.hasNext()) {
                    val = iterator.next();
                    classOfVal=val.getClass();
                }
                else {  //it's an empty collection
                    val = null;
                    classOfVal=NullType.class;
                }
            }

            if (val!=null) {
                if (DateTime.class.equals(cls) || Date.class.equals(cls)) {
                    try{
                        val=new DateTime(val.toString());
                        if (Date.class.equals(cls))
                            val=((DateTime)val).toDate();
                    }
                    catch (Exception e){
                        val = null;
                    }
                }
                else
                if (String.class.equals(cls))
                    val = val.toString();
                else
                if (!classOfVal.equals(cls))
                    val = null;
            }
        }

        try {
            return cls.cast(val);
        }
        catch (Exception e){
            return null;
        }

    }

getUri()

String org.gluu.oxtrust.model.scim2.CustomAttributes.getUri ( )

inline

Retrieves the URI to which this CustomAttributes instance is tied.

戻り値

The URI as a String

                           {
        return uri;
    }

getValue()

public<T> T org.gluu.oxtrust.model.scim2.CustomAttributes.getValue ( String  name, Class< T >  cls  )

inlinepackage

Returns the value of a custom attribute as an instance of the specified type. If you are not sure about the data type of the attribute, use String for type parameter T: in this case toString is used to generate a representation.

引数

name	The name of the custom attribute
cls	Specifies the type utilized to read the attribute value
<T>	Type parameter for cls

戻り値

null if the attribute is not known to this object, or if it was not possible to read its value using the type provided. Otherwise, the value associated to the attribute is returned (when the attribute is multivalued, only the first value found is taken into account: use getValues to get all values).

                                                    {

        if (!IntrospectUtil.isCollection(cls)){
            Object val=attributeMap.get(name);
            return getTypedValue(val, cls);
        }
        else
            return null;
    }

getValues()

public<T> List<T> org.gluu.oxtrust.model.scim2.CustomAttributes.getValues ( String  name, Class< T >  cls  )

inlinepackage

Returns the values of a multi-valued custom attribute as a List of objects of the specified type. If you are not sure about the data type of the attribute, use String for type parameter T: in this case toString is used to generate a representation.

引数

name	The name of the custom attribute
cls	Specifies the type utilized to read the attribute values
<T>	Type parameter for cls

戻り値

null if the attribute is not known to this object, or if it was not possible to read any of its values using the type provided. Otherwise, a list of values associated to the attribute is returned (when the attribute is not multivalued, a singleton list is returned: use getValue to get atomic values instead).

                                                           {

        Object val=attributeMap.get(name);
        List<T> list=null;

        if (val!=null){

            if (IntrospectUtil.isCollection(val.getClass())) {
                list = new ArrayList<T>();

                for (Object item : (Collection) val){
                    T aValue=getTypedValue(item, cls);

                    if (aValue==null){
                        list=null;
                        break;
                    }
                    else
                        list.add(aValue);
                }
                if (list!=null && list.size()==0)
                    list=null;
            }
            else {  //Create a list with one element
                T aValue=getTypedValue(val, cls);
                list= aValue==null ? null :  Collections.singletonList(aValue);
            }
        }

        return list;
    }

remove()

void org.gluu.oxtrust.model.scim2.CustomAttributes.remove ( String  name )

inline

Removes an attribute (and associated value) from this object

引数

name	The name of the attribute to remove. Use the exactly the same String as when the attribute was set

                                   {
        attributeMap.remove(name);
    }

set()

void org.gluu.oxtrust.model.scim2.CustomAttributes.set ( String  name, Object  value  )

inlineprivate

                                               {
        if (StringUtils.isNotEmpty(name) && value!=null){
            attributeMap.put(name, value);
        }
    }

setAttribute() [1/7]

void org.gluu.oxtrust.model.scim2.CustomAttributes.setAttribute ( String  name, String  value  )

inline

Sets the value of an attribute using a String.

引数

name	Name of attribute
value	A String object. Must be non-null, or else it won't be stored

                                                       {
        set(name, value);
    }

setAttribute() [2/7]

void org.gluu.oxtrust.model.scim2.CustomAttributes.setAttribute ( String  name, Boolean  value  )

inline

Sets the value of an attribute using a Boolean.

引数

name	Name of attribute
value	A Boolean object. Must be non-null, or else it won't be stored

                                                        {
        set(name, value);
    }

setAttribute() [3/7]

void org.gluu.oxtrust.model.scim2.CustomAttributes.setAttribute ( String  name, Double  value  )

inline

Sets the value of an attribute using a Double.

引数

name	Name of attribute
value	A Double object. Must be non-null, or else it won't be stored

                                                       {
        set(name, value);
    }

setAttribute() [4/7]

void org.gluu.oxtrust.model.scim2.CustomAttributes.setAttribute ( String  name, Integer  value  )

inline

Sets the value of an attribute using an Integer.

引数

name	Name of attribute
value	An Integer object. Must be non-null, or else it won't be stored

                                                        {
        set(name, value);
    }

setAttribute() [5/7]

void org.gluu.oxtrust.model.scim2.CustomAttributes.setAttribute ( String  name, DateTime  value  )

inline

Sets the value of an attribute using a Joda DateTime.

引数

name	Name of attribute
value	A DateTime object. Must be non-null, or else it won't be stored

                                                         {
        if (value!=null)
            setAttribute(name, ISODateTimeFormat.dateTime().print(value));
    }

setAttribute() [6/7]

void org.gluu.oxtrust.model.scim2.CustomAttributes.setAttribute ( String  name, Date  value  )

inline

Sets the value of an attribute using a JDK Date.

引数

name	Name of attribute
value	A Date object. Must be non-null, or else it won't be stored

                                                     {
        if (value!=null)
            setAttribute(name, ISODateTimeFormat.dateTime().print(new DateTime(value)));
    }

setAttribute() [7/7]

void org.gluu.oxtrust.model.scim2.CustomAttributes.setAttribute ( String  name, List<?>  values  )

inline

Sets the value of an attribute using a List of objects.

引数

name	Name of attribute
values	A non-empty, non-null list of values.

                                                         {
        if (values!=null && values.size()>0)
            set(name, values);
    }

メンバ詳解

attributeMap

Map<String, Object> org.gluu.oxtrust.model.scim2.CustomAttributes.attributeMap

private

uri

String org.gluu.oxtrust.model.scim2.CustomAttributes.uri

private

---

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

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