QUserTokenPolicy Class

(QOpcUa::QUserTokenPolicy)

The OPC UA UserTokenPolicy. More...

Header: #include <QtOpcUa/qopcuatype.h>
qmake: QT += opcua

Public Types

enum TokenType { Anonymous, Username, Certificate, IssuedToken }

Public Functions

QUserTokenPolicy()
QUserTokenPolicy(const QOpcUa::QUserTokenPolicy &rhs)
~QUserTokenPolicy()
QString issuedTokenType() const
QString issuerEndpointUrl() const
QString policyId() const
QString securityPolicyUri() const
void setIssuedTokenType(const QString &issuedTokenType)
void setIssuerEndpointUrl(const QString &issuerEndpointUrl)
void setPolicyId(const QString &policyId)
void setSecurityPolicyUri(const QString &securityPolicyUri)
void setTokenType(QOpcUa::QUserTokenPolicy::TokenType tokenType)
QOpcUa::QUserTokenPolicy::TokenType tokenType() const
QOpcUa::QUserTokenPolicy &operator=(const QOpcUa::QUserTokenPolicy &rhs)

Detailed Description

The OPC UA UserTokenPolicy.

The user token policy contains information about an user token accepted by the server.

Member Type Documentation

enum QUserTokenPolicy::TokenType

ConstantValueDescription
QOpcUa::QUserTokenPolicy::Anonymous0No token required.
QOpcUa::QUserTokenPolicy::Username1Username and password are required.
QOpcUa::QUserTokenPolicy::Certificate2A client certificate is required.
QOpcUa::QUserTokenPolicy::IssuedToken3Any Web Services Security (WS-Security) defined token.

Member Function Documentation

QUserTokenPolicy::QUserTokenPolicy()

Default constructs an instance of QUserTokenPolicy.

QUserTokenPolicy::QUserTokenPolicy(const QOpcUa::QUserTokenPolicy &rhs)

Constructs an user token policy from rhs.

QUserTokenPolicy::~QUserTokenPolicy()

Destroys the instance of QUserTokenPolicy.

QString QUserTokenPolicy::issuedTokenType() const

Returns the URI for the token type.

See also setIssuedTokenType().

QString QUserTokenPolicy::issuerEndpointUrl() const

Returns the URL of a token issuing service.

See also setIssuerEndpointUrl().

QString QUserTokenPolicy::policyId() const

Returns a server assigned identifier for this policy.

See also setPolicyId().

QString QUserTokenPolicy::securityPolicyUri() const

Returns the URI of the security policy required when encrypting or signing the token for ActivateSession.

See also setSecurityPolicyUri().

void QUserTokenPolicy::setIssuedTokenType(const QString &issuedTokenType)

Sets the URI for the token type to issuedTokenType.

See also issuedTokenType().

void QUserTokenPolicy::setIssuerEndpointUrl(const QString &issuerEndpointUrl)

Sets the URL of the token issuing service to issuerEndpointUrl.

See also issuerEndpointUrl().

void QUserTokenPolicy::setPolicyId(const QString &policyId)

Sets the identifier for this policy to policyId.

See also policyId().

void QUserTokenPolicy::setSecurityPolicyUri(const QString &securityPolicyUri)

Sets the URI of the security policy to securityPolicyUri.

See also securityPolicyUri().

void QUserTokenPolicy::setTokenType(QOpcUa::QUserTokenPolicy::TokenType tokenType)

Sets the type of the required user identity token to tokenType.

See also tokenType().

QOpcUa::QUserTokenPolicy::TokenType QUserTokenPolicy::tokenType() const

Returns the type of the required user identity token.

See also setTokenType().

QOpcUa::QUserTokenPolicy &QUserTokenPolicy::operator=(const QOpcUa::QUserTokenPolicy &rhs)

Sets the values from rhs in this user token policy.

© 2018 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.