SecureEnvironment.Create SecureEnvironment.Create SecureEnvironment.Create SecureEnvironment.Create Method

Definition

Creates a secure client session for rights management operations.

Overloads

Create(String, ContentUser) Create(String, ContentUser) Create(String, ContentUser) Create(String, ContentUser)

Creates a secure client session for a specified user with a given rights manifest.

Create(String, AuthenticationType, UserActivationMode) Create(String, AuthenticationType, UserActivationMode) Create(String, AuthenticationType, UserActivationMode)

Creates a secure client session given an application rights manifest, AuthenticationType, and UserActivationMode.

Examples

The following example shows how to use this method to create a secure environment.

string applicationManifest = "<manifest></manifest>";
if (File.Exists("rpc.xml"))
{
    StreamReader manifestReader = File.OpenText("rpc.xml");
    applicationManifest = manifestReader.ReadToEnd();
}

if (_secureEnv == null)
{
    if (SecureEnvironment.IsUserActivated(new ContentUser(
                _currentUserId, AuthenticationType.Windows)))
    {
        _secureEnv = SecureEnvironment.Create(
            applicationManifest, new ContentUser(
                _currentUserId, AuthenticationType.Windows));
    }
    else
    {
        _secureEnv = SecureEnvironment.Create(
            applicationManifest,
            AuthenticationType.Windows,
            UserActivationMode.Permanent);
    }
}
Dim applicationManifest As String = "<manifest></manifest>"
If File.Exists("rpc.xml") Then
	Dim manifestReader As StreamReader = File.OpenText("rpc.xml")
	applicationManifest = manifestReader.ReadToEnd()
End If

If _secureEnv Is Nothing Then
	If SecureEnvironment.IsUserActivated(New ContentUser(_currentUserId, AuthenticationType.Windows)) Then
		_secureEnv = SecureEnvironment.Create(applicationManifest, New ContentUser(_currentUserId, AuthenticationType.Windows))
	Else
		_secureEnv = SecureEnvironment.Create(applicationManifest, AuthenticationType.Windows, UserActivationMode.Permanent)
	End If
End If

Create(String, ContentUser) Create(String, ContentUser) Create(String, ContentUser) Create(String, ContentUser)

Creates a secure client session for a specified user with a given rights manifest.

public:
 static System::Security::RightsManagement::SecureEnvironment ^ Create(System::String ^ applicationManifest, System::Security::RightsManagement::ContentUser ^ user);
public static System.Security.RightsManagement.SecureEnvironment Create (string applicationManifest, System.Security.RightsManagement.ContentUser user);
static member Create : string * System.Security.RightsManagement.ContentUser -> System.Security.RightsManagement.SecureEnvironment
Public Shared Function Create (applicationManifest As String, user As ContentUser) As SecureEnvironment

Parameters

applicationManifest
String String String String

The application rights manifest.

user
ContentUser ContentUser ContentUser ContentUser

The user or user-group for granting access to rights managed content.

Returns

A secure client session for activation, license binding, and other rights management operations.

Examples

The following example shows how to use this method to create a secure environment.

string applicationManifest = "<manifest></manifest>";
if (File.Exists("rpc.xml"))
{
    StreamReader manifestReader = File.OpenText("rpc.xml");
    applicationManifest = manifestReader.ReadToEnd();
}

if (_secureEnv == null)
{
    if (SecureEnvironment.IsUserActivated(new ContentUser(
                _currentUserId, AuthenticationType.Windows)))
    {
        _secureEnv = SecureEnvironment.Create(
            applicationManifest, new ContentUser(
                _currentUserId, AuthenticationType.Windows));
    }
    else
    {
        _secureEnv = SecureEnvironment.Create(
            applicationManifest,
            AuthenticationType.Windows,
            UserActivationMode.Permanent);
    }
}
Dim applicationManifest As String = "<manifest></manifest>"
If File.Exists("rpc.xml") Then
	Dim manifestReader As StreamReader = File.OpenText("rpc.xml")
	applicationManifest = manifestReader.ReadToEnd()
End If

If _secureEnv Is Nothing Then
	If SecureEnvironment.IsUserActivated(New ContentUser(_currentUserId, AuthenticationType.Windows)) Then
		_secureEnv = SecureEnvironment.Create(applicationManifest, New ContentUser(_currentUserId, AuthenticationType.Windows))
	Else
		_secureEnv = SecureEnvironment.Create(applicationManifest, AuthenticationType.Windows, UserActivationMode.Permanent)
	End If
End If

Remarks

This Create method is intended for use with users that are already activated, such as provided in the list returned from GetActivatedUsers. Use the alternate Create method for users that are not yet activated.

See also

Create(String, AuthenticationType, UserActivationMode) Create(String, AuthenticationType, UserActivationMode) Create(String, AuthenticationType, UserActivationMode)

Creates a secure client session given an application rights manifest, AuthenticationType, and UserActivationMode.

public:
 static System::Security::RightsManagement::SecureEnvironment ^ Create(System::String ^ applicationManifest, System::Security::RightsManagement::AuthenticationType authentication, System::Security::RightsManagement::UserActivationMode userActivationMode);
public static System.Security.RightsManagement.SecureEnvironment Create (string applicationManifest, System.Security.RightsManagement.AuthenticationType authentication, System.Security.RightsManagement.UserActivationMode userActivationMode);
static member Create : string * System.Security.RightsManagement.AuthenticationType * System.Security.RightsManagement.UserActivationMode -> System.Security.RightsManagement.SecureEnvironment

Parameters

applicationManifest
String String String String

The application rights manifest.

authentication
AuthenticationType AuthenticationType AuthenticationType AuthenticationType

The method of authentication.

userActivationMode
UserActivationMode UserActivationMode UserActivationMode UserActivationMode

The type of the user rights account certificate.

Returns

A secure client session for activation, license binding, and other rights management operations.

Examples

The following example shows how to use this method to create a secure environment.

string applicationManifest = "<manifest></manifest>";
if (File.Exists("rpc.xml"))
{
    StreamReader manifestReader = File.OpenText("rpc.xml");
    applicationManifest = manifestReader.ReadToEnd();
}

if (_secureEnv == null)
{
    if (SecureEnvironment.IsUserActivated(new ContentUser(
                _currentUserId, AuthenticationType.Windows)))
    {
        _secureEnv = SecureEnvironment.Create(
            applicationManifest, new ContentUser(
                _currentUserId, AuthenticationType.Windows));
    }
    else
    {
        _secureEnv = SecureEnvironment.Create(
            applicationManifest,
            AuthenticationType.Windows,
            UserActivationMode.Permanent);
    }
}
Dim applicationManifest As String = "<manifest></manifest>"
If File.Exists("rpc.xml") Then
	Dim manifestReader As StreamReader = File.OpenText("rpc.xml")
	applicationManifest = manifestReader.ReadToEnd()
End If

If _secureEnv Is Nothing Then
	If SecureEnvironment.IsUserActivated(New ContentUser(_currentUserId, AuthenticationType.Windows)) Then
		_secureEnv = SecureEnvironment.Create(applicationManifest, New ContentUser(_currentUserId, AuthenticationType.Windows))
	Else
		_secureEnv = SecureEnvironment.Create(applicationManifest, AuthenticationType.Windows, UserActivationMode.Permanent)
	End If
End If

Remarks

This Create method is intended for new users that are not yet activated.

Activating a new user includes a roundtrip server transaction to obtain the User Certificate and Client License Certificate.

The alternate Create method can be used if a user is already activated, such as provided in the list returned from GetActivatedUsers.

Applies to