Package dev.galasa.zossecurity

Interface IZosUserid

public interface IZosUserid
Represents a pooled userid

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    connectToGroup(String group)
    Connect this userid to a group
    void
    delete()
    Delete the userid.
    void
    free()
    Free the userid.
    IZosGroup[]
    getConnectedGroups()
    Returns a list of connected groups for this userid
    String
    getPassphrase()
    Retrieve the passphrase
    String
    getPassword()
    Retrieve the password
    String
    getUserid()
    Retreive the userid
    IZosImage
    getZosImage()
    Retrieve the zOS image this userid belongs to
    void
    removeFromGroup(String group)
    Remove this userid from a group
    void
    resume()
    Resume the userid
    void
    revoke()
    Revoke the userid
    void
    setPassword(String password, String passphrase)
    Set the password and/or the passphrase.
    void
    setPassword(String password, String passphrase, boolean expire)
    Set the password and/or the passphrase, with or without expiry
    void
    setWhen(String days, String time)
    Sets the WHEN option for a RACF userid.
    Days can be
    ANYDAY Specifies that the user can access the system on any day.
    WEEKDAYS Specifies that the user can access the system only on weekdays (Monday through Friday).
    day ...

  • Method Details

    • getUserid

      String getUserid()
      Retreive the userid
      Returns:
      The userid

    • getPassword

      String getPassword()
      Retrieve the password
      Returns:
      The password, will never be null

    • getPassphrase

      String getPassphrase()
      Retrieve the passphrase
      Returns:
      The passphrase, may be null if one hasn't been set

    • getZosImage

      IZosImage getZosImage()
      Retrieve the zOS image this userid belongs to
      Returns:
      zOS image

    • setPassword

      void setPassword(String password, String passphrase) throws ZosSecurityManagerException
      Set the password and/or the passphrase.

      A password must always be set, the passphrase is optional

      Parameters:
      password - The password to be set, mandatory
      passphrase - The passphrase to be set, optional
      Throws:
      ZosSecurityManagerException

    • setPassword

      void setPassword(String password, String passphrase, boolean expire) throws ZosSecurityManagerException
      Set the password and/or the passphrase, with or without expiry

      A password must always be set, the passphrase is optional

      Parameters:
      password - The password to be set, mandatory
      passphrase - The passphrase to be set, optional
      expire - true = expired to be set with the password
      Throws:
      ZosSecurityManagerException

    • revoke

      void revoke() throws ZosSecurityManagerException
      Revoke the userid
      Throws:
      ZosSecurityManagerException

    • resume

      void resume() throws ZosSecurityManagerException
      Resume the userid
      Throws:
      ZosSecurityManagerException

    • connectToGroup

      void connectToGroup(String group) throws ZosSecurityManagerException
      Connect this userid to a group
      Parameters:
      group -
      Throws:
      ZosSecurityManagerException

    • removeFromGroup

      void removeFromGroup(String group) throws ZosSecurityManagerException
      Remove this userid from a group
      Parameters:
      group -
      Throws:
      ZosSecurityManagerException

    • getConnectedGroups

      IZosGroup[] getConnectedGroups()
      Returns a list of connected groups for this userid
      Returns:
      list of groups

    • setWhen

      void setWhen(String days, String time) throws ZosSecurityManagerException
      Sets the WHEN option for a RACF userid.
      Days can be
      ANYDAY Specifies that the user can access the system on any day.
      WEEKDAYS Specifies that the user can access the system only on weekdays (Monday through Friday).
      day ... Specifies that the user can access the system only on the days specified, where day can be
      MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, or SUNDAY, and you can specify the days in any order.
      space separated. Time can be
      ANYTIME Specifies that the user can access the system at any time.
      start-time:end-time Specifies that the user can access the system only during the specified time period. The format of both start-time and end-time is hhmm, where hh is the hour in 24-hour notation (00 - 23) and mm is the minutes (00 - 59). Note that 0000 is not a valid time value.
      If start-time is greater than end-time, the interval spans midnight and extends into the following day.
      Parameters:
      days - - eg "MONDAY" or "MONDAY TUESDAY" or "ANYDAY"
      time - - eg "0400:1900" or "ANYTIME"
      Throws:
      ZosSecurityManagerException

    • free

      void free() throws ZosSecurityManagerException
      Free the userid. This will be performed automatically at the end of the run
      Throws:
      ZosSecurityManagerException

    • delete

      void delete() throws ZosSecurityManagerException
      Delete the userid.
      Throws:
      ZosSecurityManagerException