UserIdentificationImpl (scheduling 14.0.2 API)

java.lang.Object
- org.ow2.proactive.scheduler.common.job.UserIdentification
- - org.ow2.proactive.scheduler.job.UserIdentificationImpl

All Implemented Interfaces:

Serializable, Comparable<UserIdentification>
```
public class UserIdentificationImpl
extends UserIdentification
```
This class will be able to authenticate a client.

Since:

ProActive Scheduling 0.9

See Also:

Serialized Form

Field Summary
- Fields inherited from class org.ow2.proactive.scheduler.common.job.UserIdentification
  ASC_ORDER, DESC_ORDER, SORT_BY_CONNECTION, SORT_BY_HOST, SORT_BY_LASTSUBMIT, SORT_BY_NAME, SORT_BY_SUBMIT, toRemove

Constructor Summary

Constructors
Constructor and Description
`UserIdentificationImpl(String username, String tenant, String domain)` Constructor of user identification using user name.
`UserIdentificationImpl(String username, Subject subject)` Constructor of user identification using user name and admin property.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSubmit()` Add one to the submit number
`void`	`cancelSession()` Cancel the current session of the user
`boolean`	`checkPermission(Permission permission, String errorMessage)` Checks if user has the specified permission.
`boolean`	`equals(Object obj)`
`long`	`getConnectionTime()` Get the time of the connection of this user.
`String`	`getDomain()` Return the domain name associated with the current user, or null if no domain is associated
`Set<String>`	`getGroups()` To get the groups associated with this user name
`String`	`getHostName()` Get the host name of this user.
`long`	`getLastSubmitTime()` Get the last time this user has submit a job.
`Set<JobPriority>`	`getPriorityPermission()`
`TimerTask`	`getSession()` Get the session for this user (timer task)
`Subject`	`getSubject()` Gets user's subject retrieved from JAAS authentication
`int`	`getSubmitNumber()` Get the number of submit for this user.
`String`	`getTenant()` Return the tenant associated with the current user, or null if no tenant is associated
`HashSet<SchedulerEvent>`	`getUserEvents()` Returns the userEvents.
`String`	`getUsername()` To get the user name
`int`	`hashCode()`
`boolean`	`isAllCatalogPermission()` Check if the user has all catalog permission
`boolean`	`isAllJobPlannerPermission()` Check if the user has all job planner permission
`boolean`	`isAllTenantPermission()`
`boolean`	`isCanCreateAssociationPermission()` Check if the user can create a job-planner association
`boolean`	`isHandleOnlyMyJobsPermission()` Check if the user has permission to handle only its jobs
`boolean`	`isMyEventsOnly()` Get the myEventsOnly.
`boolean`	`isNotificationAdminPermission()` Check if the user has all Notification Service permissions;
`boolean`	`isOtherUsersJobReadPermission()` Check if the user has permission to read other users' jobs
`boolean`	`isPcaAdminPermission()` Check if the user has all Service Automation permissions
`boolean`	`isRMCoreAllPermission()` Check if the user has all Resource Manager permissions
`boolean`	`isSchedulerAdminPermission()` Check if the user has all Scheduler permissions
`void`	`setHostName(String hostName)` Sets the hostName to the given hostName value.
`void`	`setMyEventsOnly(boolean myEventsOnly)` Set the myEventsOnly value to the given myEventsOnly value.
`void`	`setSession(TimerTask session)` Set the session value to the given session value If the user has already a session active, it will be cancelled and replaced by the new one.
`void`	`setToRemove()` Set this user to be removed by update method.
`void`	`setUserEvents(SchedulerEvent[] events)` Sets the userEvents to the given userEvents value.
`String`	`toString()`

Methods inherited from class org.ow2.proactive.scheduler.common.job.UserIdentification
compareTo, isToRemove, setSortingBy, setSortingOrder

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UserIdentificationImpl
```
public UserIdentificationImpl(String username,
                              String tenant,
                              String domain)
```
    Constructor of user identification using user name.
    
    Parameters:
    
    username - the user name.
    
    tenant - user tenant
  - UserIdentificationImpl
```
public UserIdentificationImpl(String username,
                              Subject subject)
```
    Constructor of user identification using user name and admin property.
    
    Parameters:
    
    username - the user name.
    
    subject - contains all user's principals and permissions
- Method Detail
  - setToRemove
```
public void setToRemove()
```
    Set this user to be removed by update method.
  - getUsername
```
public String getUsername()
```
    Description copied from class: UserIdentification
    
    To get the user name
    
    Specified by:
    
    getUsername in class UserIdentification
    
    Returns:
    
    the user name
    
    See Also:
    
    UserIdentification.getUsername()
  - getGroups
```
public Set<String> getGroups()
```
    Description copied from class: UserIdentification
    
    To get the groups associated with this user name
    
    Specified by:
    
    getGroups in class UserIdentification
    
    Returns:
    
    a set of groups
  - getTenant
```
public String getTenant()
```
    Description copied from class: UserIdentification
    
    Return the tenant associated with the current user, or null if no tenant is associated
    
    Specified by:
    
    getTenant in class UserIdentification
    
    Returns:
    
    user tenant
  - getDomain
```
public String getDomain()
```
    Description copied from class: UserIdentification
    
    Return the domain name associated with the current user, or null if no domain is associated
    
    Specified by:
    
    getDomain in class UserIdentification
    
    Returns:
    
    user domain
  - isAllTenantPermission
```
public boolean isAllTenantPermission()
```
    Specified by:
    
    isAllTenantPermission in class UserIdentification
    
    Returns:
  - getPriorityPermission
```
public Set<JobPriority> getPriorityPermission()
```
  - isAllJobPlannerPermission
```
public boolean isAllJobPlannerPermission()
```
    Description copied from class: UserIdentification
    
    Check if the user has all job planner permission
    
    Specified by:
    
    isAllJobPlannerPermission in class UserIdentification
  - isAllCatalogPermission
```
public boolean isAllCatalogPermission()
```
    Description copied from class: UserIdentification
    
    Check if the user has all catalog permission
    
    Specified by:
    
    isAllCatalogPermission in class UserIdentification
  - isCanCreateAssociationPermission
```
public boolean isCanCreateAssociationPermission()
```
    Description copied from class: UserIdentification
    
    Check if the user can create a job-planner association
    
    Specified by:
    
    isCanCreateAssociationPermission in class UserIdentification
  - isPcaAdminPermission
```
public boolean isPcaAdminPermission()
```
    Description copied from class: UserIdentification
    
    Check if the user has all Service Automation permissions
    
    Specified by:
    
    isPcaAdminPermission in class UserIdentification
  - isNotificationAdminPermission
```
public boolean isNotificationAdminPermission()
```
    Description copied from class: UserIdentification
    
    Check if the user has all Notification Service permissions;
    
    Specified by:
    
    isNotificationAdminPermission in class UserIdentification
  - isRMCoreAllPermission
```
public boolean isRMCoreAllPermission()
```
    Description copied from class: UserIdentification
    
    Check if the user has all Resource Manager permissions
    
    Specified by:
    
    isRMCoreAllPermission in class UserIdentification
  - isSchedulerAdminPermission
```
public boolean isSchedulerAdminPermission()
```
    Description copied from class: UserIdentification
    
    Check if the user has all Scheduler permissions
    
    Specified by:
    
    isSchedulerAdminPermission in class UserIdentification
    
    Returns:
  - isHandleOnlyMyJobsPermission
```
public boolean isHandleOnlyMyJobsPermission()
```
    Description copied from class: UserIdentification
    
    Check if the user has permission to handle only its jobs
    
    Specified by:
    
    isHandleOnlyMyJobsPermission in class UserIdentification
  - isOtherUsersJobReadPermission
```
public boolean isOtherUsersJobReadPermission()
```
    Description copied from class: UserIdentification
    
    Check if the user has permission to read other users' jobs
    
    Specified by:
    
    isOtherUsersJobReadPermission in class UserIdentification
  - addSubmit
```
public void addSubmit()
```
    Add one to the submit number
  - getSubmitNumber
```
public int getSubmitNumber()
```
    Description copied from class: UserIdentification
    
    Get the number of submit for this user.
    
    Specified by:
    
    getSubmitNumber in class UserIdentification
    
    Returns:
    
    the number of submit for this user.
    
    See Also:
    
    UserIdentification.getSubmitNumber()
  - getUserEvents
```
public HashSet<SchedulerEvent> getUserEvents()
```
    Returns the userEvents.
    
    Returns:
    
    the userEvents.
  - setHostName
```
public void setHostName(String hostName)
```
    Sets the hostName to the given hostName value.
    
    Parameters:
    
    hostName - the hostName to set.
  - setUserEvents
```
public void setUserEvents(SchedulerEvent[] events)
```
    Sets the userEvents to the given userEvents value. If the given value is null, user will listen to every events.
    
    Parameters:
    
    events - the userEvents to set.
  - getConnectionTime
```
public long getConnectionTime()
```
    Description copied from class: UserIdentification
    
    Get the time of the connection of this user.
    
    Specified by:
    
    getConnectionTime in class UserIdentification
    
    Returns:
    
    the time of the connection of this user.
    
    See Also:
    
    UserIdentification.getConnectionTime()
  - getHostName
```
public String getHostName()
```
    Description copied from class: UserIdentification
    
    Get the host name of this user.
    
    Specified by:
    
    getHostName in class UserIdentification
    
    Returns:
    
    the host name of this user.
    
    See Also:
    
    UserIdentification.getHostName()
  - getLastSubmitTime
```
public long getLastSubmitTime()
```
    Description copied from class: UserIdentification
    
    Get the last time this user has submit a job.
    
    Specified by:
    
    getLastSubmitTime in class UserIdentification
    
    Returns:
    
    the last time this user has submit a job.
    
    See Also:
    
    UserIdentification.getLastSubmitTime()
  - isMyEventsOnly
```
public boolean isMyEventsOnly()
```
    Description copied from class: UserIdentification
    
    Get the myEventsOnly.
    
    Specified by:
    
    isMyEventsOnly in class UserIdentification
    
    Returns:
    
    the myEventsOnly.
    
    See Also:
    
    UserIdentification.isMyEventsOnly()
  - setMyEventsOnly
```
public void setMyEventsOnly(boolean myEventsOnly)
```
    Set the myEventsOnly value to the given myEventsOnly value.
    
    Parameters:
    
    myEventsOnly - the myEventsOnly to set.
  - getSession
```
public TimerTask getSession()
```
    Description copied from class: UserIdentification
    
    Get the session for this user (timer task)
    
    Specified by:
    
    getSession in class UserIdentification
    
    Returns:
    
    the session for this user, null if it has no session.
    
    See Also:
    
    UserIdentification.getSession()
  - cancelSession
```
public void cancelSession()
```
    Cancel the current session of the user
  - setSession
```
public void setSession(TimerTask session)
```
    Set the session value to the given session value If the user has already a session active, it will be cancelled and replaced by the new one.
    
    Parameters:
    
    session - the session to set
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true if the two users seems exactly equals.
    
    See Also:
    
    Object.equals(java.lang.Object)
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    See Also:
    
    Object.toString()
  - checkPermission
```
public boolean checkPermission(Permission permission,
                               String errorMessage)
                        throws PermissionException
```
    Checks if user has the specified permission.
    
    Returns:
    
    true if it has, throw SecurityException otherwise with specified error message
    
    Throws:
    
    PermissionException
  - getSubject
```
public Subject getSubject()
```
    Gets user's subject retrieved from JAAS authentication
    
    Returns:
    
    user's subject

Class UserIdentificationImpl

Field Summary

Fields inherited from class org.ow2.proactive.scheduler.common.job.UserIdentification

Constructor Summary

Method Summary

Methods inherited from class org.ow2.proactive.scheduler.common.job.UserIdentification

Methods inherited from class java.lang.Object

Constructor Detail

UserIdentificationImpl

UserIdentificationImpl

Method Detail

setToRemove

getUsername

getGroups

getTenant

getDomain

isAllTenantPermission

getPriorityPermission

isAllJobPlannerPermission

isAllCatalogPermission

isCanCreateAssociationPermission

isPcaAdminPermission

isNotificationAdminPermission

isRMCoreAllPermission

isSchedulerAdminPermission

isHandleOnlyMyJobsPermission

isOtherUsersJobReadPermission

addSubmit

getSubmitNumber

getUserEvents

setHostName

setUserEvents

getConnectionTime

getHostName

getLastSubmitTime

isMyEventsOnly

setMyEventsOnly

getSession

cancelSession

setSession

hashCode

equals

toString

checkPermission

getSubject