exa.bee.deploy.v10

Class Role

java.lang.Object

exa.bee.deploy.v10.Role

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class Role
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

A Role in the CloudView process. The list of valid Roles can be found
in the CloudView deployment guide

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	name
java.util.List<RoleAttribute>	roleAttribute

Constructor Summary

Constructors

Constructor and Description
Role()
Role(Role o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	addAttribute(java.lang.String name, java.lang.String value)
void	check(boolean deep, java.lang.String errorContext) Checks this Role.
static Role	fromString(java.lang.String s) String representation of this Role.
java.lang.String	getName() $CONSTRAINTS
java.util.List<RoleAttribute>	getRoleAttribute() -
java.util.Map<java.lang.String,RoleAttribute>	getRoleAttributeAsMap() Get the map of RoleAttribute, indexed by name
RoleAttribute	getRoleAttributeByName(java.lang.String _lookup) Get the RoleAttribute for which the name matches _lookup
Role	makeCopy() Creates and returns a deep copy of this Role.
static Role	readFrom(java.io.InputStream is) Read this Role from an XML fragment.
boolean	removeRoleAttributeByName(java.lang.String _lookup) Removes the RoleAttribute for which the name matches _lookup
void	setName(java.lang.String name) $CONSTRAINTS
java.lang.String	toString() String representation of this Role.
Role	withName(java.lang.String name)
Role	withRoleAttribute(java.util.Collection<RoleAttribute> __values)
Role	withRoleAttribute(RoleAttribute... __values) -
void	writeTo(java.io.OutputStream os) Write this Role as an XML fragment

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name

public java.lang.String name

roleAttribute

public java.util.List<RoleAttribute> roleAttribute

Constructor Detail

Role

public Role()

Role

public Role(Role o)

Copy constructor

Method Detail

setName

public void setName(java.lang.String name)

$CONSTRAINTS

getName

public java.lang.String getName()

$CONSTRAINTS

withName

public Role withName(java.lang.String name)

getRoleAttribute

public java.util.List<RoleAttribute> getRoleAttribute()

-

getRoleAttributeByName

public RoleAttribute getRoleAttributeByName(java.lang.String _lookup)

Get the RoleAttribute for which the name matches _lookup

Returns:

null if no matching RoleAttribute is found

getRoleAttributeAsMap

public java.util.Map<java.lang.String,RoleAttribute> getRoleAttributeAsMap()

Get the map of RoleAttribute, indexed by name

removeRoleAttributeByName

public boolean removeRoleAttributeByName(java.lang.String _lookup)

Removes the RoleAttribute for which the name matches _lookup

Returns:

false if no matching RoleAttribute is found, true if one was found

withRoleAttribute

public Role withRoleAttribute(RoleAttribute... __values)

-

withRoleAttribute

public Role withRoleAttribute(java.util.Collection<RoleAttribute> __values)

makeCopy

public Role makeCopy()

Creates and returns a deep copy of this Role.

readFrom

public static Role readFrom(java.io.InputStream is)
                     throws javax.xml.bind.JAXBException

Read this Role from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this Role as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static Role fromString(java.lang.String s)
                       throws javax.xml.bind.JAXBException,
                              java.io.UnsupportedEncodingException

String representation of this Role.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this Role.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this Role.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException

addAttribute

public void addAttribute(java.lang.String name,
                         java.lang.String value)