Class LoginAccount
- Direct Known Subclasses:
PersonAccount
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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGets the value of the requested propertyList<byte[]>Gets the value of the certificate property.getDataType(String propName) Gets the Java type of the value of the provided property.byte[]Gets the value of the >password property.Gets the value of the principalName property.static ListgetPropertyNames(String entityTypeName) Gets a list of all supported properties for this model object, LoginAccountgetRealm()Gets the value of the realm property.static HashSetGets a set of any model objects which extend this model object, LoginAccountGets a list of any model objects which this model object, LoginAccount, is an extension of.Gets the name of this model object, LoginAccountbooleanisMandatory(String propName) Returns true if the provided property is a mandatory property; false, otherwise.booleanisMultiValuedProperty(String propName) Return whether the specified property is a multi-valued property and capable of holding multiple values.booleanisPersistentProperty(String propName) Returns true if the provided property is a persistent property; false, otherwise.booleanReturns true if the requested property is set; false, otherwise.booleanReturns a true if the certificate property is set; false, otherwise.booleanReturns a true if the password property is set; false, otherwise.booleanReturns a true if the principalName property is set; false, otherwise.booleanReturns a true if the realm property is set; false, otherwise.booleanReturns a true if the provided model object is one that this model object extends; false, otherwise.voidSets the value of the provided property to the provided value.voidsetPassword(byte[] value) Sets the value of the password property.voidsetPrincipalName(String value) Sets the value of the principalName property.voidSets the value of the realm property.toString()Returns this model object, LoginAccount, and its contents as a StringvoidSets the value of provided property to null.voidResets the certificate property to nullMethods inherited from class com.ibm.wsspi.security.wim.model.RolePlayer
getPartyRoles, isSetPartyRoles, unsetPartyRolesMethods inherited from class com.ibm.wsspi.security.wim.model.Entity
getChangeType, getChildren, getCreateTimestamp, getEntitlementInfo, getGroups, getIdentifier, getModifyTimestamp, getParent, getSubEntityTypes, getViewIdentifiers, isSetChangeType, isSetChildren, isSetCreateTimestamp, isSetEntitlementInfo, isSetGroups, isSetIdentifier, isSetModifyTimestamp, isSetParent, isSetViewIdentifiers, isUnset, reInitializePropertyNames, setChangeType, setCreateTimestamp, setEntitlementInfo, setIdentifier, setModifyTimestamp, setParent, unsetChildren, unsetGroups, unsetViewIdentifiers
-
Constructor Details
-
LoginAccount
public LoginAccount()
-
-
Method Details
-
getPrincipalName
Gets the value of the principalName property.- Returns:
- possible object is
String
-
setPrincipalName
Sets the value of the principalName property.- Parameters:
value- allowed object isString
-
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
Gets the value of the realm property.- Returns:
- possible object is
String
-
setRealm
Sets the value of the realm property.- Parameters:
value- allowed object isString
-
isSetRealm
public boolean isSetRealm()Returns a true if the realm property is set; false, otherwise.- Returns:
- returned object is
boolean
-
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
setmethod 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
Gets the value of the requested property -
isSet
Returns true if the requested property is set; false, otherwise. -
set
Sets the value of the provided property to the provided value. -
unset
Sets the value of provided property to null. -
getTypeName
Gets the name of this model object, LoginAccount- Overrides:
getTypeNamein classParty- Returns:
- returned object is
String
-
isMandatory
Description copied from class:EntityReturns true if the provided property is a mandatory property; false, otherwise.- Overrides:
isMandatoryin classParty- Returns:
- returned object is
boolean
-
isPersistentProperty
Description copied from class:EntityReturns true if the provided property is a persistent property; false, otherwise.- Overrides:
isPersistentPropertyin classParty- Returns:
- returned object is
boolean
-
getPropertyNames
Gets a list of all supported properties for this model object, LoginAccount -
getDataType
Gets the Java type of the value of the provided property. For example: String, List- Overrides:
getDataTypein classParty- Parameters:
propName- allowed object isString- Returns:
- returned object is
String
-
getSuperTypes
Gets a list of any model objects which this model object, LoginAccount, is an extension of.- Overrides:
getSuperTypesin classParty- Returns:
- returned object is
ArrayList
-
isSubType
Returns a true if the provided model object is one that this model object extends; false, otherwise. -
getSubTypes
Gets a set of any model objects which extend this model object, LoginAccount- Returns:
- returned object is
HashSet
-
toString
Returns this model object, LoginAccount, and its contents as a String -
isMultiValuedProperty
Description copied from class:EntityReturn whether the specified property is a multi-valued property and capable of holding multiple values.- Overrides:
isMultiValuedPropertyin classRolePlayer- Parameters:
propName- The property name to check.- Returns:
- True if the property is multi-value, false otherwise.
-