Package com.ibm.wsspi.security.wim.model

Class LoginAccount

java.lang.Object
com.ibm.wsspi.security.wim.model.Entity
com.ibm.wsspi.security.wim.model.RolePlayer
com.ibm.wsspi.security.wim.model.Party
com.ibm.wsspi.security.wim.model.LoginAccount
Direct Known Subclasses:
PersonAccount
public class LoginAccount extends Party

Java class for LoginAccount complex type.

The following schema fragment specifies the expected content contained within this class. 

 <complexType name="LoginAccount">
 <complexContent>
 <extension base="{http://www.ibm.com/websphere/wim}Party">
 <sequence>
 <element ref="{http://www.ibm.com/websphere/wim}principalName" minOccurs="0"/>
 <element ref="{http://www.ibm.com/websphere/wim}password" minOccurs="0"/>
 <element ref="{http://www.ibm.com/websphere/wim}realm" minOccurs="0"/>
 <element ref="{http://www.ibm.com/websphere/wim}certificate" maxOccurs="unbounded" minOccurs="0"/>
 </sequence>
 </extension>
 </complexContent>
 </complexType>

The LoginAccount object is extended from the Party object, and ultimately the RolePlayer object, to enable LoginAccounts to play roles.

The LoginAccount object is an entity type which contains the common properties for all sub-types of this object. It has the following properties defined:

  • principalName: specifies the name of the user associated with this LoginAccount.
  • password: specifies the password for the user specified in principalName.
  • realm: specifies the realm in which this user exists.
  • certificate property specifies the certificate the user may be authenticated with.

A principal may have multiple LoginAccounts.

  • Constructor Details

    • LoginAccount

      public LoginAccount()

  • Method Details

    • getPrincipalName

      public String getPrincipalName()
      Gets the value of the principalName property.
      Returns:
      possible object is String

    • setPrincipalName

      public void setPrincipalName(String value)
      Sets the value of the principalName property.
      Parameters:
      value - allowed object is String

    • isSetPrincipalName

      public boolean isSetPrincipalName()
      Returns a true if the principalName property is set; false, otherwise.
      Returns:
      returned object is boolean

    • getPassword

      public byte[] getPassword()
      Gets the value of the >password property.
      Returns:
      possible object is byte[]

    • setPassword

      public void setPassword(byte[] value)
      Sets the value of the password property.
      Parameters:
      value - allowed object is byte[]

    • isSetPassword

      public boolean isSetPassword()
      Returns a true if the password property is set; false, otherwise.
      Returns:
      returned object is boolean

    • getRealm

      public String getRealm()
      Gets the value of the realm property.
      Returns:
      possible object is String

    • setRealm

      public void setRealm(String value)
      Sets the value of the realm property.
      Parameters:
      value - allowed object is String

    • isSetRealm

      public boolean isSetRealm()
      Returns a true if the realm property is set; false, otherwise.
      Returns:
      returned object is boolean

    • getCertificate

      public List<byte[]> getCertificate()
      Gets the value of the certificate property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the certificate property.

      For example, to add a new item, do as follows: 

       getCertificate().add(newItem);

      Objects of the following type(s) are allowed in the list byte[]

    • isSetCertificate

      public boolean isSetCertificate()
      Returns a true if the certificate property is set; false, otherwise.
      Returns:
      returned object is boolean

    • unsetCertificate

      public void unsetCertificate()
      Resets the certificate property to null

    • get

      public Object get(String propName)
      Gets the value of the requested property
      Overrides:
      get in class Party
      Parameters:
      propName - allowed object is String
      Returns:
      returned object is Object

    • isSet

      public boolean isSet(String propName)
      Returns true if the requested property is set; false, otherwise.
      Overrides:
      isSet in class Party
      Returns:
      returned object is boolean

    • set

      public void set(String propName, Object value)
      Sets the value of the provided property to the provided value.
      Overrides:
      set in class Party
      Parameters:
      propName - allowed object is String
      value - allowed object is Object

    • unset

      public void unset(String propName)
      Sets the value of provided property to null.
      Overrides:
      unset in class Party
      Parameters:
      propName - allowed object is String

    • getTypeName

      public String getTypeName()
      Gets the name of this model object, LoginAccount
      Overrides:
      getTypeName in class Party
      Returns:
      returned object is String

    • isMandatory

      public boolean isMandatory(String propName)
      Description copied from class: Entity
      Returns true if the provided property is a mandatory property; false, otherwise.
      Overrides:
      isMandatory in class Party
      Returns:
      returned object is boolean

    • isPersistentProperty

      public boolean isPersistentProperty(String propName)
      Description copied from class: Entity
      Returns true if the provided property is a persistent property; false, otherwise.
      Overrides:
      isPersistentProperty in class Party
      Returns:
      returned object is boolean

    • getPropertyNames

      public static List getPropertyNames(String entityTypeName)
      Gets a list of all supported properties for this model object, LoginAccount
      Parameters:
      entityTypeName - allowed object is String
      Returns:
      returned object is List

    • getDataType

      public String getDataType(String propName)
      Gets the Java type of the value of the provided property. For example: String, List
      Overrides:
      getDataType in class Party
      Parameters:
      propName - allowed object is String
      Returns:
      returned object is String

    • getSuperTypes

      public ArrayList getSuperTypes()
      Gets a list of any model objects which this model object, LoginAccount, is an extension of.
      Overrides:
      getSuperTypes in class Party
      Returns:
      returned object is ArrayList

    • isSubType

      public boolean isSubType(String superTypeName)
      Returns a true if the provided model object is one that this model object extends; false, otherwise.
      Overrides:
      isSubType in class Party
      Parameters:
      superTypeName - allowed object is String
      Returns:
      returned object is boolean

    • getSubTypes

      public static HashSet getSubTypes()
      Gets a set of any model objects which extend this model object, LoginAccount
      Returns:
      returned object is HashSet

    • toString

      public String toString()
      Returns this model object, LoginAccount, and its contents as a String
      Overrides:
      toString in class Party
      Returns:
      returned object is String

    • isMultiValuedProperty

      public boolean isMultiValuedProperty(String propName)
      Description copied from class: Entity
      Return whether the specified property is a multi-valued property and capable of holding multiple values.
      Overrides:
      isMultiValuedProperty in class RolePlayer
      Parameters:
      propName - The property name to check.
      Returns:
      True if the property is multi-value, false otherwise.