CSenIdentityProvider Class Reference
#include
<mw/SenIdentityProvider.h>
Link against: SenServDesc.lib
class CSenIdentityProvider : public CSenXmlServiceDescription |
Public Member Functions |
---|
virtual | ~CSenIdentityProvider() |
IMPORT_C TPtrC8 | AccountExtensions(CSenElement *&) |
virtual IMPORT_C TPtrC8 | AdvisoryAuthnID() |
virtual IMPORT_C TPtrC8 | AuthzID() |
IMPORT_C HBufC8 * | HttpCredentialsL(MSenIdentityManager &) |
IMPORT_C const TDesC8 & | IMEI() |
IMPORT_C TBool | IsDefault() |
IMPORT_C TBool | IsTrustedByL(MSenServiceDescription &) |
IMPORT_C TBool | IsTrustedByL(const TDesC8 &) |
virtual IMPORT_C const TDesC8 & | NewElementName() |
IMPORT_C CSenIdentityProvider * | NewL(const TDesC8 &) |
IMPORT_C CSenIdentityProvider * | NewL(const TDesC8 &, const TDesC8 &) |
IMPORT_C CSenIdentityProvider * | NewL(const TDesC8 &, const TDesC8 &, const TDesC8 &) |
IMPORT_C CSenIdentityProvider * | NewL(const TDesC8 &, const TDesC8 &, const TDesC8 &, const TDesC8 &) |
IMPORT_C CSenIdentityProvider * | NewLC(const TDesC8 &) |
IMPORT_C CSenIdentityProvider * | NewLC(const TDesC8 &, const TDesC8 &) |
IMPORT_C CSenIdentityProvider * | NewLC(const TDesC8 &, const TDesC8 &, const TDesC8 &) |
IMPORT_C CSenIdentityProvider * | NewLC(const TDesC8 &, const TDesC8 &, const TDesC8 &, const TDesC8 &) |
virtual IMPORT_C TPtrC8 | Password() |
IMPORT_C TPtrC8 | ProviderID() |
IMPORT_C TInt | SetAccountExtensionsL(const TDesC8 &) |
IMPORT_C TInt | SetProviderID(const TDesC8 &) |
IMPORT_C TInt | SetProviderIdL(const TDesC8 &) |
IMPORT_C TInt | SetServiceID(const TDesC8 &) |
IMPORT_C TInt | SetUserInfoL(const TDesC8 &, const TDesC8 &, const TDesC8 &) |
IMPORT_C TPtrC8 | UserName() |
Inherited Functions |
---|
| CBase::CBase() |
| CBase::Delete(CBase *) |
| CBase::Extension_(TUint,TAny *&,TAny *) |
| CBase::operator new(TUint) |
| CBase::operator new(TUint,TAny *) |
| CBase::operator new(TUint,TLeave) |
| CBase::operator new(TUint,TLeave,TUint) |
| CBase::operator new(TUint,TUint) |
| CBase::~CBase() |
| CSenBaseFragment::AllocContentSaverL() |
| CSenBaseFragment::AsElement() |
| CSenBaseFragment::BuildFrom(const TDesC8 &) |
| CSenBaseFragment::CSenBaseFragment() |
| CSenBaseFragment::ConsistsOfL(MSenFragment &) |
| CSenBaseFragment::Content() |
| CSenBaseFragment::ContentOf(const TDesC8 &) |
| CSenBaseFragment::DelegateParsingL(MSenFragment &) |
| CSenBaseFragment::DelegateParsingL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &) |
| CSenBaseFragment::DetachL() |
| CSenBaseFragment::EnsureNamespace(const TDesC8 &) |
| CSenBaseFragment::ExtractElement() |
| CSenBaseFragment::LocalName()const |
| CSenBaseFragment::Namespace(const TDesC8 &) |
| CSenBaseFragment::NsPrefix()const |
| CSenBaseFragment::NsUri()const |
| CSenBaseFragment::ParseL(const TDesC8 &) |
| CSenBaseFragment::Reader() |
| CSenBaseFragment::ResetContentL() |
| CSenBaseFragment::SaveNamespacesL(const RAttributeArray &,TBool) |
| CSenBaseFragment::SetContentOfL(const TDesC8 &,const TDesC8 &) |
| CSenBaseFragment::SetOwner(MSenFragment &) |
| CSenBaseFragment::SetReader(CSenXmlReader &) |
| CSenBaseFragment::StartEntity(TDesC8 &) |
| CSenBaseFragment::~CSenBaseFragment() |
| CSenDomFragment::BaseConstructL(CSenXmlReader &) |
| CSenDomFragment::BaseConstructL(const CSenElement &) |
| CSenDomFragment::BaseConstructL(const TDesC8 &) |
| CSenDomFragment::BaseConstructL(const TDesC8 &,const TDesC8 &) |
| CSenDomFragment::BaseConstructL(const TDesC8 &,const TDesC8 &,const TDesC8 &) |
| CSenDomFragment::BaseConstructL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &) |
| CSenDomFragment::BaseConstructL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &,CSenElement &) |
| CSenDomFragment::CSenDomFragment() |
| CSenDomFragment::CharactersL(const TDesC8 &,TInt,TInt) |
| CSenDomFragment::ExpandL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &) |
| CSenDomFragment::NewL(const CSenElement &) |
| CSenDomFragment::NewL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &) |
| CSenDomFragment::NewL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &,CSenElement &) |
| CSenDomFragment::ParseWithL(CSenXmlReader &) |
| CSenDomFragment::WriteEndElementL(const TDesC8 &,const TDesC8 &,const TDesC8 &) |
| CSenDomFragment::WriteStartElementL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &) |
| CSenDomFragment::~CSenDomFragment() |
| CSenXmlServiceDescription::Accepts(MSenProviderPolicy &) |
| CSenXmlServiceDescription::AddFacetL(const CSenFacet &) |
| CSenXmlServiceDescription::AddIdentityProviderIdL(TDesC8 &) |
| CSenXmlServiceDescription::AsXmlL() |
| CSenXmlServiceDescription::AsXmlUnicodeL() |
| CSenXmlServiceDescription::CSenXmlServiceDescription(TDescriptionClassType) |
| CSenXmlServiceDescription::ConstructL() |
| CSenXmlServiceDescription::Contract() |
| CSenXmlServiceDescription::Credentials() |
| CSenXmlServiceDescription::DescriptionClassType() |
| CSenXmlServiceDescription::EndElementL(const TDesC8 &,const TDesC8 &,const TDesC8 &) |
| CSenXmlServiceDescription::Endpoint() |
| CSenXmlServiceDescription::FacetValue(TDesC8 &,HBufC8 *&) |
| CSenXmlServiceDescription::FacetsL(RFacetArray &) |
| CSenXmlServiceDescription::FrameworkId() |
| CSenXmlServiceDescription::FrameworkVersion() |
| CSenXmlServiceDescription::HasEqualPrimaryKeysL(MSenServiceDescription &) |
| CSenXmlServiceDescription::HasFacetL(const TDesC8 &,TBool &) |
| CSenXmlServiceDescription::IapId(TUint32 &) |
| CSenXmlServiceDescription::IdentityProviderIds8L() |
| CSenXmlServiceDescription::IsLocalL() |
| CSenXmlServiceDescription::Matches(MSenServiceDescription &) |
| CSenXmlServiceDescription::NewL() |
| CSenXmlServiceDescription::NewLC() |
| CSenXmlServiceDescription::PromptUserInfo() |
| CSenXmlServiceDescription::ProviderId() |
| CSenXmlServiceDescription::RebuildFrom(MSenProviderPolicy &) |
| CSenXmlServiceDescription::RemoveFacet(const TDesC8 &) |
| CSenXmlServiceDescription::ResumeParsingFromL(const TDesC8 &,const TDesC8 &,const TDesC8 &) |
| CSenXmlServiceDescription::ScoreMatchL(MSenServiceDescription &) |
| CSenXmlServiceDescription::ServicePolicy() |
| CSenXmlServiceDescription::SetAttributesL(const RAttributeArray &) |
| CSenXmlServiceDescription::SetContractL(const TDesC8 &) |
| CSenXmlServiceDescription::SetEndPointL(const TDesC8 &) |
| CSenXmlServiceDescription::SetFacetL(const CSenFacet &) |
| CSenXmlServiceDescription::SetFrameworkIdL(const TDesC8 &) |
| CSenXmlServiceDescription::SetIapIdL(TUint32) |
| CSenXmlServiceDescription::SetIdentityProviderIdsL(CSenIdentityProviderIdArray8 &) |
| CSenXmlServiceDescription::SetPolicyL(const TDesC8 &) |
| CSenXmlServiceDescription::SetPolicyL(const TDesC8 &,const TDesC8 &) |
| CSenXmlServiceDescription::SetPolicyL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const TDesC8 &) |
| CSenXmlServiceDescription::SetPromptUserInfoL(TBool) |
| CSenXmlServiceDescription::SetSnapIdL(TUint32) |
| CSenXmlServiceDescription::SetTransportCueL(const TDesC8 &) |
| CSenXmlServiceDescription::SetTransportPropertiesL(const TDesC8 &) |
| CSenXmlServiceDescription::SnapId(TUint32 &) |
| CSenXmlServiceDescription::StartElementL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &) |
| CSenXmlServiceDescription::TransportCue() |
| CSenXmlServiceDescription::TransportPropertiesL(HBufC8 *&) |
| CSenXmlServiceDescription::WriteAsXMLToL(RWriteStream &) |
| CSenXmlServiceDescription::~CSenXmlServiceDescription() |
Detailed Description
Class describes some IdentityProvider service Class is intented to be used when registrating information about some identity providing service. In case of ID-WSF framework, the IdentityProvider and Authentication Service are behind same endpoint. Typically, ID-WSF service consumers call both RegisterIdentityProviderL() and RegisterServiceDescriptionL() methods as defined in Service Management API (CSenServiceManager). Basic Web Service consumers use this class to register BASIC-AUTH credentials to certain pre-known service endpoint.
- Since
- Series60 3.0
Constructor & Destructor Documentation
CSenIdentityProvider ( TDescriptionClassType )
IMPORT_C | CSenIdentityProvider | ( | TDescriptionClassType | aType | ) | [protected] |
~CSenIdentityProvider ( )
IMPORT_C | ~CSenIdentityProvider | ( | ) | [virtual] |
Member Function Documentation
AccountExtensions ( CSenElement *& )
AdvisoryAuthnID ( )
IMPORT_C TPtrC8 | AdvisoryAuthnID | ( | ) | [virtual] |
A getter.
- Since
- Series60 3.0
Returns: a pointer to advisory authentication id
AuthzID ( )
IMPORT_C TPtrC8 | AuthzID | ( | ) | [virtual] |
A getter.
- Since
- Series60 3.0
Returns: a pointer to authorization id
ConstructL ( const TDesC8 & )
IMPORT_C void | ConstructL | ( | const TDesC8 & | aEndPoint | ) | [protected] |
Standard 2nd phase constructor.
- Since
- Series60 3.0
ConstructL ( const TDesC8 &, const TDesC8 & )
IMPORT_C void | ConstructL | ( | const TDesC8 & | aEndPoint, |
| const TDesC8 & | aContract |
| ) | [protected] |
Parameter | Description | aContract | identifies the service type. Typically some URN. Default contract is Liberty ID-WSF Authentication Service"urn:liberty:as:2004-04". |
ConstructL ( const TDesC8 &, const TDesC8 &, const TDesC8 & )
IMPORT_C void | ConstructL | ( | const TDesC8 & | aEndPoint, |
| const TDesC8 & | aContract, |
| const TDesC8 & | aProviderID |
| ) | [protected] |
Parameter | Description | aContract | identifies the service type. Typically some URN. Default contract is Liberty ID-WSF Authentication Service"urn:liberty:as:2004-04". |
aProviderID | is identifier of this IdentityProvider. It is a unique key pointing to some known endpoint. Required only for ID-WSF framework. |
ConstructL ( const TDesC8 &, const TDesC8 &, const TDesC8 &, const TDesC8 & )
IMPORT_C void | ConstructL | ( | const TDesC8 & | aEndPoint, |
| const TDesC8 & | aContract, |
| const TDesC8 & | aProviderID, |
| const TDesC8 & | aServiceID |
| ) | [protected] |
Parameter | Description | aContract | identifies the service type. Typically some URN. Default contract is Liberty ID-WSF Authentication Service"urn:liberty:as:2004-04". |
aProviderID | is identifier of this IdentityProvider. It is a unique key pointing to some known endpoint. Required only for ID-WSF framework. |
aServiceID | is a unique contract to some invocable service. Typically some URN. If this IDP is registered to ID-WSF framework, this ServiceID will be appended into list of services which trust this IDP, and the actual IDP "knows". |
HttpCredentialsL ( MSenIdentityManager & )
IMPORT_C HBufC8 * | HttpCredentialsL | ( | MSenIdentityManager & | aIdMgr | ) | |
Deprecated. This method is no longer in use. Creates http-credentials by making password-username pair and encoding it with BASE-64.
- Since
- Series60 3.0
Parameter | Description | aIdMgr | Identitymanager which is used to obtain a password if no password for this identityprovider was set. |
Returns: a newly allocated credentialbuffer. Ownership is transferred to the caller.
IMEI ( )
A getter.
- Since
- Series60 3.0
Returns: a pointer to IMEI
IsDefault ( )
IMPORT_C TBool | IsDefault | ( | ) | |
Checks if this identity provider is set as default .
- Since
- Series60 3.0
Returns: ETrue if default-attribute was set, EFalse otherwise
IsTrustedByL ( MSenServiceDescription & )
Parameter | Description | aServiceDescription | the service description to check |
Returns: ETrue if the ServiceDescription, i.e. its endpoint or contract, is associated to this IdentityProvider. Or if the ServiceDescription is about this IdentityProvider. EFalse otherwise
IsTrustedByL ( const TDesC8 & )
IMPORT_C TBool | IsTrustedByL | ( | const TDesC8 & | aProviderIdOrServiceId | ) | |
Parameter | Description | aProviderIdOrServiceId | IdentityProvider ID, or Service ID which is being checked. Service ID is typically URI (service contract or service endpoint). |
Returns: ETrue if the ServiceDescription, i.e. its endpoint or contract, is associated to this IdentityProvider. Or if the ServiceDescription is about this IdentityProvider. EFalse otherwise
NewElementName ( )
IMPORT_C const TDesC8 & | NewElementName | ( | ) | [virtual] |
Returns: Descriptor containing service description local name for this service description. This is the localname of the element, when this class is represented as an XML element.
NewL ( const TDesC8 & )
Two-phased constructor. Note: contract defaults here to "urn:liberty:as:2004-04"
- Since
- Series60 3.0
Parameter | Description | aEndpoint | the service endpoint. Note that endpoint cannot include characters which are illegal in XML. If endpoint is an URL which contains illegal characters (like '&'-char), those need to be encoded into XML entity form (like &). EncodeHttpCharactersLC() method from XmlUtils can be used for encoding of basic XML entities. |
Returns: a new CSenIdentityProvider
NewL ( const TDesC8 &, const TDesC8 & )
Two-phased constructor.
- Since
- Series60 3.0
Parameter | Description | aEndpoint | the service endpoint. Note that endpoint cannot include characters which are illegal in XML. If endpoint is an URL which contains illegal characters (like '&'-char), those need to be encoded into XML entity form (like &). EncodeHttpCharactersLC() method from XmlUtils can be used for encoding of basic XML entities. |
aContract | identifies the service type. Typically some URN. Default is Liberty ID-WSF Authentication Service contract: -- urn:liberty:as:2004-04 |
Returns: a new CSenIdentityProvider
NewL ( const TDesC8 &, const TDesC8 &, const TDesC8 & )
Two-phased constructor.
- Since
- Series60 3.0
Parameter | Description | aEndpoint | the service endpoint. Note that endpoint cannot include characters which are illegal in XML. If endpoint is an URL which contains illegal characters (like '&'-char), those need to be encoded into XML entity form (like &). EncodeHttpCharactersLC() method from XmlUtils can be used for encoding of basic XML entities. |
aContract | identifies the service type. Typically some URN. Default is Liberty ID-WSF Authentication Service contract: -- urn:liberty:as:2004-04 |
aProviderID | is identifier of this IdentityProvider. It is a unique key pointing to some known endpoint. |
Returns: a new CSenIdentityProvider
NewL ( const TDesC8 &, const TDesC8 &, const TDesC8 &, const TDesC8 & )
Two-phased constructor.
- Since
- Series60 3.0
Parameter | Description | aEndpoint | the service endpoint. Note that endpoint cannot include characters which are illegal in XML. If endpoint is an URL which contains illegal characters (like '&'-char), those need to be encoded into XML entity form (like &). EncodeHttpCharactersLC() method from XmlUtils can be used for encoding of basic XML entities. |
aContract | identifies the service type. Typically some URN. Default is Liberty ID-WSF Authentication Service contract: -- urn:liberty:as:2004-04 |
aProviderID | is identifier of this IdentityProvider. It is a unique key pointing to some known endpoint. Required only for ID-WSF framework. |
aServiceID | is a unique contract to some invocable service. Typically some URN. If this IDP is registered to ID-WSF framework, this ServiceID will be appended into list of services which trust this IDP, and the actual IDP "knows". |
Returns: a new CSenIdentityProvider
NewLC ( const TDesC8 & )
Two-phased constructor. Note: contract defaults here to "urn:liberty:as:2004-04"
- Since
- Series60 3.0
Parameter | Description | aEndpoint | the service endpoint. Note that endpoint cannot include characters which are illegal in XML. If endpoint is an URL which contains illegal characters (like '&'-char), those need to be encoded into XML entity form (like &). EncodeHttpCharactersLC() method from XmlUtils can be used for encoding of basic XML entities. |
Returns: a new CSenIdentityProvider, which pointer is left on cleanup stack.
NewLC ( const TDesC8 &, const TDesC8 & )
Two-phased constructor.
- Since
- Series60 3.0
Parameter | Description | aEndpoint | the service endpoint. Note that endpoint cannot include characters which are illegal in XML. If endpoint is an URL which contains illegal characters (like '&'-char), those need to be encoded into XML entity form (like &). EncodeHttpCharactersLC() method from XmlUtils can be used for encoding of basic XML entities. |
aContract | identifies the service type. Typically some URN. Default is Liberty ID-WSF Authentication Service contract: -- urn:liberty:as:2004-04 |
Returns: a new CSenIdentityProvider, which pointer is left on cleanup stack.
NewLC ( const TDesC8 &, const TDesC8 &, const TDesC8 & )
Two-phased constructor.
- Since
- Series60 3.0
Parameter | Description | aEndpoint | the service endpoint. Note that endpoint cannot include characters which are illegal in XML. If endpoint is an URL which contains illegal characters (like '&'-char), those need to be encoded into XML entity form (like &). EncodeHttpCharactersLC() method from XmlUtils can be used for encoding of basic XML entities. |
aContract | identifies the service type. Typically some URN. Default is Liberty ID-WSF Authentication Service contract: -- urn:liberty:as:2004-04 |
aProviderID | is identifier of this IdentityProvider. It is a unique key pointing to some known endpoint. Required only for ID-WSF framework. |
Returns: a new CSenIdentityProvider, which pointer is left on cleanup stack.
NewLC ( const TDesC8 &, const TDesC8 &, const TDesC8 &, const TDesC8 & )
Two-phased constructor.
- Since
- Series60 3.0
Parameter | Description | aEndpoint | the service endpoint. Note that endpoint cannot include characters which are illegal in XML. If endpoint is an URL which contains illegal characters (like '&'-char), those need to be encoded into XML entity form (like &). EncodeHttpCharactersLC() method from XmlUtils can be used for encoding of basic XML entities. |
aContract | identifies the service type. Typically some URN. Default is Liberty ID-WSF Authentication Service contract: -- urn:liberty:as:2004-04 |
aProviderID | is identifier of this IdentityProvider. It is a unique key pointing to some known endpoint. Required only for ID-WSF framework. |
aServiceID | is a unique contract to some invocable service. Typically some URN. If this IDP is registered to ID-WSF framework, this ServiceID will be appended into list of services which trust this IDP, and the actual IDP "knows". |
Returns: a new CSenIdentityProvider, which pointer is left on cleanup stack.
Password ( )
IMPORT_C TPtrC8 | Password | ( | ) | [virtual] |
A getter.
- Since
- Series60 3.0
Returns: a pointer to password
ProviderID ( )
A getter.
- Since
- Series60 3.0
Returns: a pointer to provider id
SetAccountExtensionsL ( const TDesC8 & )
IMPORT_C TInt | SetAccountExtensionsL | ( | const TDesC8 & | aDetail | ) | |
SetProviderID ( const TDesC8 & )
IMPORT_C TInt | SetProviderID | ( | const TDesC8 & | aProviderID | ) | |
Setter
- Since
- Series60 3.0
Parameter | Description | aProviderID | the set id |
Returns: KErrNone or other system-wide Symbian error codes.
SetProviderIdL ( const TDesC8 & )
IMPORT_C TInt | SetProviderIdL | ( | const TDesC8 & | aProviderID | ) | |
Setter for (identity) provider ID (leaving variant)
- Since
- Series60 4.0
Parameter | Description | aProviderID | the unique identifier of the (identity) provider |
Returns: KErrNone on success, KErrArgument if aProviderID is a zero-length descriptor, or one of the system-wide error codes otherwise.
SetServiceID ( const TDesC8 & )
IMPORT_C TInt | SetServiceID | ( | const TDesC8 & | aServiceID | ) | |
Setter for ServiceID. ServiceID is the contract of some invocable service, typically some URN. Note, that when registering an IDP the possibly existing list of ServiceIDs is not cleared, but the ServiceID set via this method is added as new entry into that list, if it was non-existent.
- Since
- Series60 3.0
Parameter | Description | aServiceID | the set id |
Returns: KErrNone or other system-wide Symbian error codes.
SetUserInfoL ( const TDesC8 &, const TDesC8 &, const TDesC8 & )
Sets the user information. Status codes: KErrNone ok Other codes are system error codes.
- Since
- Series60 3.0
Parameter | Description | aAuthzID | Authorization id. |
aAdvisoryAuthnID | Advisory authorization id. |
aPassword | Password. |
Returns: status/error code.
UserName ( )
A getter.
- Since
- Series60 3.0
Returns: a pointer to username