Overview Package Class Deprecated Help

security
User

The User Class contains specific configuration parameters for e-mail, login times, local password, etc. General access related parameters are in the UserBase class.

public class User

Properties
creationTime

type=Date
access=read-only
default=0
Displayed(tab/group)=Creation Time
email

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=E-mail Address
enableClientIpAddressValidation Enable IP address validation on client login

type=boolean
default=false
Displayed(tab/group)=Enable IP Address validation (/Client IP Address)
firstLoginPasswordChange

type=boolean
default=false
Displayed(tab/group)=Force User Password Change (/Password)
lastLogin

type=Date
access=read-only
default=0
Displayed(tab/group)=Last Login
lastPasswordRenewal

type=Date
access=read-only
default=0
maxOssSessionsAllowed Maximum number of OSS sessions, 0 means that there is no limit. The limit applies separately to JMS and http(s) sessions.

type=int
default=0
minimum=0
maximum=30
Displayed(tab/group)=Maximum OSS Sessions Allowed (/OSS Session)
maxSessionsAllowed Maximum number of operator positions for a user. 0 means that there is no limit.

type=int
default=0
Displayed(tab/group)=Maximum User Operator Positions Allowed (/UI Session)
numAuthFailures

type=int
access=read-only
default=0
ossAlarmFilterName

type=string
default=
minimum=0
maximum=255
Displayed(tab/group)=Public Alarm Filter for OSS (/OSS Session)
ossAlarmFilterPointer The pointer to the fm.AlarmObject filter on JMS messages for OSS connections for this user.

type=Pointer
default=
Displayed(tab/group)=Public Alarm Filter for OSS (/OSS Session)
ossRequestTimeout The maximum amount of time (in seconds) an OSS XML API request by this user will wait to begin processing before timing out.

type=int
default=60
minimum=0
maximum=600
Displayed(tab/group)=OSS Request Timeout (seconds) (/OSS Session)
password Note: The user password is for internal server use and cannot be read by client applications.

type=string
default=
minimum=8
maximum=100
Displayed(tab/group)=User Password (/Password)
priority The priority of requests that are processed in NFM-P Server.

type=security.PriorityType
default=low
Displayed(tab/group)=OSS Request Priority (/OSS Session)
salt

type=string
timeBeforeLastLogin

type=Date
access=read-only
default=0
validClientIpAddress Client login limited to this IP address

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=Valid Client IP address (/Client IP Address)
validClientIpAddressType Type of client IP address

type=rtr.InetAddressType
access=read-only
default=ipv4
  
Properties inherited from security.UserBase
currentDigest, description, isRemote, scopeOfCommandProfileId, scopeOfCommandProfileName, spanOfControlProfileId, spanOfControlProfileName, state, userGroup, userGroupDisplayName, userGroupPointer, userName
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

getUXPrefs

Retrieve UX specific configuration.
Input Parameters:
instanceFullName : string - the full name of the object.
prefName : string - The preference name.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
contents : string - The preferences.
Exceptions:
security.User.getUXPrefsException

removeUXPrefs

Save UX based preferences.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName : string - the full name of the object.
prefName : string - The preference name.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
security.User.removeUXPrefsException

saveUXPrefs

Save UX based preferences.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName : string - the full name of the object.
prefName : string - The preference name.
contents : string - The preferences.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
objectFullName : string - The full name of the newly created preference.
Exceptions:
security.User.saveUXPrefsException