Package com.dassault_systemes.plmsecssobase

   
Class SSOCredential

 
Class Hierarchy
java.lang.Object
  |
  +-com.dassault_systemes.plmsecssobase.SSOCredential
Class Location

Framework : PLMSecuritySSOBase

Module : PLMSecSSOBase

Class Description

public class SSOCredential

Author:
smq The SSOCredential represents an object to manipulate Single Sign On Credentials It is an Attribute/Value pair. Credential are grouped by ApplicationType (EV5, IPD) and by instances within a type. It means that a single user may have multiple CredentialSets (a group of credential for a given instance of a given application type) per Application If there are credentials define for a given user and for a given application type, there is always one set of credentials which is the default one for this user and this application type
Field Summary

Constructor Summary
SSOCredential()

Method Summary
public String getCredentialApplicationID()
Retrieve the instance name of the application for which the credential is defined
public String getCredentialApplicationType()
public String getCredentialName()
public String getCredentialValue()
public SSOCredentialDescriptor getDescriptor()
public String getOwner()
public static SSOCredential[] readArrayOfSSOCredentialFromXML(String iCredentialArray)
Build an array of SSOCredential from an XML string
public static SSOCredential readFromString(String iCredential)
Build an SSOCredential from an XML string
public void setCredentialApplicationID(String iValue)
public void setCredentialApplicationType(String iValue)
public void setCredentialName(String iValue)
Set the name of the credential
public void setCredentialValue(String iValue)
public void setDescriptor(SSOCredentialDescriptor iValue)
public void setOwner(String iValue)
public String toString()
public static String writeArrayOfSSOCredentialAsXml(SSOCredential[] array)


Field Detail

Constructor Detail

SSOCredential

    SSOCredential()


Method Detail

getCredentialApplicationID

    public String getCredentialApplicationID()

Retrieve the instance name of the application for which the credential is defined

Return:
the instance name

getCredentialApplicationType

    public String getCredentialApplicationType()

Return:
Retrieve the name of the application (eg: EV5,IPD) for which the credential is define

getCredentialName

    public String getCredentialName()

Return:
Retrieve the name of the credential

getCredentialValue

    public String getCredentialValue()

Return:
Retrieve the value of the credential

getDescriptor

    public SSOCredentialDescriptor getDescriptor()

Return:
Retrieve the descriptor of the credential. This object is the metadata of the credential

getOwner

    public String getOwner()

Return:
Retrieve the owner of the credential

readArrayOfSSOCredentialFromXML

    public static SSOCredential[] readArrayOfSSOCredentialFromXML(String iCredentialArray)

Build an array of SSOCredential from an XML string

Parameters:
iCredentialArray
the XMLString
Return:
the built array of SSOCredential

readFromString

    public static SSOCredential readFromString(String iCredential)

Build an SSOCredential from an XML string

Parameters:
iCredential
: the xml string
Return:
the built SSOCredential

setCredentialApplicationID

    public void setCredentialApplicationID(String iValue)

Parameters:
iValue
sets the instance name of the application for which the credential is defined

setCredentialApplicationType

    public void setCredentialApplicationType(String iValue)

Parameters:
iValue
Retrieve the name of the application (eg: EV5,IPD) for which the credential is define

setCredentialName

    public void setCredentialName(String iValue)

Set the name of the credential


setCredentialValue

    public void setCredentialValue(String iValue)

Parameters:
iValue
:Set value of the credential

setDescriptor

    public void setDescriptor(SSOCredentialDescriptor iValue)


setOwner

    public void setOwner(String iValue)

Parameters:
iValue
Sets the owner of the credential

toString

    public String toString()

Return:
the SSOCredential as an XML format

writeArrayOfSSOCredentialAsXml

    public static String writeArrayOfSSOCredentialAsXml(SSOCredential[] array)

Return:
it returns the XML format of an array of SSOCredential


Copyright © 2000, Dassault Systèmes. All rights reserved