• NetDB_Datastore

    # The NetDB_Datastore holds the information necessary to connect to the # NetDB database or RMI server. It also contains the identity of the # NetDB User performing NetDB operations. class NetDB_Datastore javadoc

    # RMI connection information new (string path_to_configuration_file) new (string rmi_service) new (string rmi_service, string krb5_conf) new (string rmi_service, string keytab, string principal) new (string rmi_service, string keytab, string principal, string krb5_conf)
    new (string rmi_host, int rmi_port) new (string rmi_host, int rmi_port, string krb5_conf) new (string rmi_host, int rmi_port, string keytab, string principal) new (string rmi_host, int rmi_port, string keytab, string principal, string krb5_conf)
    NetDB_Datastore keytab (string keytab) string keytab ()
    NetDB_Datastore principal (string principal) string principal ()
    # Database connection information new (string path_to_configuration_file) new (string db_service, string schema, string user_name,
         string password, string search_user_name, string search_password, Directory directory)
    # When using the RMI the NetDB User is the user that connected to # the RMI and cannot be changed. When using a database connection # the NetDB User can be set using these methods. NetDB_Datastore operating_user (User op_user) NetDB_Datastore operating_user (string netid) NetDB_Datastore operating_user (int id) User operating_user ()
    end

  • NetDB

    # The NetDB class is the base class for virtually all the other NetDB classes. class NetDB javadoc

    # Objects belonging to classes that inherit from NetDB can exist without # a datastore, but in practice all objects end up associated with a NetDB # datastore. Objects can be explicitly bound to a datastore or implicitly # bound via the default datastore.
    # The default datastore is used when no other datastore is specified. Most # NetDB applications will interact with just one datastore. Setting the # default datastore allows those applications to forgo explicit binding. static void default_datastore (NetDB_Datastore datastore) static NetDB_Datastore default_datastore ()
    # Explicit binding NetDB bind (NetDB_Datastore datastore)
    NetDB_Datastore datastore () boolean is_bound ()
    # Complex objects fetched from a NetDB datastore may contain other objects. # Often only a fraction of the data associated with the the contained object # is necessary for working with the complex object. For the sake of efficiency, # these contained objects may be included with only that relevant data.
    # Accessing missing bits of incomplete objects can either complete the object # behind the scenes (autocomplete) or throw a missing data exception. Most # applications will want to treat incomplete objects as if they're complete, # so autocomplete is set to TRUE by default. For debugging, or other cases # where autocompletion is undesirable, autocomplete can be turned off. static void autocomplete (boolean autocomplete) static boolean autocomplete ()
    # Check if an object is complete. boolean is_complete ()
    # Complete an object from its associated datastore. NetDB complete ()
    # Creating a new NetDB object based on an existing object would normally # involve creating the new object, loading the existing object, and copying # the existing object data into the new object. Use this method to remove # the internal links to the NetDB datastore copy of a loaded object to get # the same result. NetDB unlink()
    # Everything has a handle, usually some identifying bit of data like name, # IP address, or prefix. Objects without a suitable bit of data use their # NetDB datastore internal ID as a handle. abstract string handle ()
    # Returns a formatted version of the object. Formats are FULL (default) # WHOIS (FULL minus sensitive / unimportant fields), HTML (FULL with CSS # tags for label and data), and WHOIS_HTML (WHOIS with CSS tags). string toString() string toString(Enumeration format)
    # Return the NetDB RMI/library version. static string version ()
    end

  • Address_Space

    class Address_Space < NetDB javadoc

    new () new (Prefix prefix, Number low_res, Number high_res) new (Prefix prefix, Number low_res, Number high_res, string comment) new (NetDB_Datastore datastore) new (NetDB_Datastore datastore, Prefix prefix, Number low_res, Number high_res) new (NetDB_Datastore datastore, Prefix prefix, Number low_res, Number high_res, string comment)
    # Returns the address space that contains the given IP address. static Address_Space containing (string IP) static Address_Space containing (IP_Address IP) static Address_Space containing (NetDB_Datastore datastore, string IP) static Address_Space containing (NetDB_Datastore datastore, IP_Address IP)
    # List the records that the current operating user has access to. If no # operating user has been specified, list them all. static array<Address_Space> list () static array<Address_Space> list (NetDB_Datastore datastore)
    # List all records (equivalent to list()/list(datastore) if all is FALSE) static array<Address_Space> list (boolean all) static array<Address_Space> list (NetDB_Datastore datastore, boolean all)
    Address_Space prefix (string prefix) Address_Space prefix (string prefix, int prefix_length) Address_Space prefix (Prefix prefix) Prefix prefix ()
    Address_Space low_res (Number low_res) BigInteger low_res () IP_Address low_res_address ()
    Address_Space high_res (Number high_res) BigInteger high_res () IP_Address high_res_address ()
    Address_Space comment (string comment) string comment ()
    # Permission to allocate addresses from an Address Space or a # subnet of an Address Space is controlled via groups. Address_Space grant_access (string group_name) Address_Space grant_access (Group group) Address_Space grant_access (Group group, Prefix subnet) Address_Space grant_access (array<Group> groups) Address_Space grant_access (array<Group> groups, Prefix subnet) Address_Space grant_access (Address_Space_ACE entry) Address_Space grant_access (array<Address_Space_ACE> acl)
    Address_Space revoke_access (string group_name) Address_Space revoke_access (Group group) Address_Space revoke_access (Group group, Prefix subnet) Address_Space revoke_access (array<Group> groups) Address_Space revoke_access (array<Group> groups, Prefix subnet) Address_Space revoke_access (Address_Space_ACE entry) Address_Space revoke_access (array<Address_Space_ACE> acl)
    array<Address_Space_ACE> get_acl ()
    Address_Space add_dhcp_setting (DHCP_Setting setting) Address_Space add_dhcp_settings (array<DHCP_Setting> settings) Address_Space remove_dhcp_setting (DHCP_Setting setting) Address_Space remove_dhcp_settings (array<DHCP_Setting> settings) array<DHCP_Setting> dhcp_settings ()
    # The current implementation only supports a single IP pool. Address_Space add_pool (IP_Pool pool) Address_Space add_pools (array<IP_Pool> pools) Address_Space remove_pool (IP_Pool pool) Address_Space remove_pools (array<IP_Pool> pools) array<IP_Pool> pools ()
    # Return an Address Space, with the given prefix length, containing # this address space and any other Address Spaces in the new range. # All existing Address Spaces involved must be in the same Network. Address_Space join (int prefix_length)
    # Returns the set of Address Spaces resulting from dividing this # Address Space into Address Spaces with the given prefix length. # Throws an error if any of the resulting Address Space's network # or broadcast addresses are in use. array<Address_Space> split (int prefix_length)
    # Join or split this Address Space using the given prefix length. array<Address_Space> resize (int prefix_length)
    end

  • Address_Space_ACE

    class Address_Space_ACE < NetDB javadoc

    new () new (Prefix subnet) new (Prefix subnet, Group group) new (Prefix subnet, array<Group>groups)
    new (NetDB_Datastore datastore) new (NetDB_Datastore datastore, Prefix subnet) new (NetDB_Datastore datastore, Prefix subnet, Group group) new (NetDB_Datastore datastore, Prefix subnet, array<Group>groups)
    Address_Space_ACE add_group (Group group) Address_Space_ACE add_groups (array<Group> groups) Address_Space_ACE remove_group (Group group) Address_Space_ACE remove_groups (array<Group> groups)
    Address_Space_ACE subnet(Prefix subnet) Prefix subnet()
    array<Group> groups ()
    end

  • Defaults

    class Defaults < NetDB javadoc # Database and application defaults and controls.

    # Default domain for new users and reporting. string DefaultDomain ([NetDB_Datastore datastore])
    # Default domain for names of private IP addresses. string PrivateAddressDomain ([NetDB_Datastore datastore])
    # Address space defaults and controls. integer DefaultLowRes ([NetDB_Datastore datastore]) integer DefaultHighRes ([NetDB_Datastore datastore]) integer MaxPrefixLengthChange ([NetDB_Datastore datastore]) integer MinVLAN ([NetDB_Datastore datastore]) boolean Reserve_IPv4_Midrange ([NetDB_Datastore datastore]) integer v4MaxPrefixLength ([NetDB_Datastore datastore]) integer v4MinPrefixLength ([NetDB_Datastore datastore]) integer v6MaxPrefixLength ([NetDB_Datastore datastore]) integer v6MinPrefixLength ([NetDB_Datastore datastore])
    # Node defaults and controls. State DefaultState ([NetDB_Datastore datastore]) integer MaxNodeCustomFields ([NetDB_Datastore datastore])
    # Application defaults and controls. integer LockTimeOut ([NetDB_Datastore datastore]) boolean CheckForLimitedDomain ([NetDB_Datastore datastore])
    end

  • DS_Record

    class DS_Record < NetDB javadoc # Delegation Signer records for delegated domains.

    new (int key_tag, int algorithm, int digest_type, string digest) new (int key_tag, int algorithm, int digest_type, string digest, boolean publish) new (NetDB_Datastore datastore, int key_tag, int algorithm, int digest_type, string digest) new (NetDB_Datastore datastore, int key_tag, int algorithm, int digest_type, string digest, boolean publish)
    int key_tag () int algorithm () int digest_type ()
    string digest ()
    DS_Record publish (boolean publish) boolean publish ()
    boolean is_published ()
    end

  • Interface

    class Interface < NetDB javadoc

    new () new (Interface_Type type, boolean roam, boolean dhcp) new (Interface_Type type, boolean roam, boolean dhcp, string hw_address, string comment) new (NetDB_Datastore datastore) new (NetDB_Datastore datastore, Interface_Type type, boolean roam, boolean dhcp) new (NetDB_Datastore datastore, Interface_Type type, boolean roam, boolean dhcp, string hw_address, string comment)
    Interface type (Interface_Type type) Interface_Type type ()
    Interface hardware_address (string hardware_address) string hardware_address ()
    Interface dhcp (boolean use_dhcp)
    Interface enable_dhcp () Interface disable_dhcp ()
    boolean is_dhcp_enabled ()
    Interface roaming (boolean roaming)
    Interface enable_roaming () Interface disable_roaming ()
    boolean can_roam ()
    # comment is not currently visible in the NetDB web application # or whois. It will be added to those when they're updated. Interface comment (string comment) string comment ()
    Interface add_name (string fqdn) Interface add_name (string name, string domain) Interface add_name (A_Name name) Interface add_names (array<A_Name> names) Interface remove_name (string fqdn) Interface remove_name (string name, string domain) Interface remove_name (A_Name name) Interface remove_names (array<A_Name> names) array<A_Name> names ()
    Interface add_address (string address) Interface add_address (string address, boolean active, int pref) Interface add_address (IP_Address address, int pref) Interface add_address (Interface_IP_Address address) Interface add_addresses (array<Interface_IP_Address> addresses) Interface remove_address (string address) Interface remove_address (IP_Address address) Interface remove_address (Interface_IP_Address address) Interface remove_addresses (array<Interface_IP_Address> addresses) array<Interface_address> addresses ()
    Interface add_dhcp_setting (DHCP_Setting setting) Interface add_dhcp_settings (array<DHCP_Setting> settings) Interface remove_dhcp_setting (DHCP_Setting setting) Interface remove_dhcp_settings (array<DHCP_Setting> settings) array<DHCP_Setting> dhcp_settings ()
    end

  • IP_Pool

    class IP_Pool < NetDB javadoc

    new () new (string comment) new (NetDB_Datastore datastore) new (NetDB_Datastore datastore, string comment)
    IP_pool comment (string comment) string comment ()
    IP_Pool add_address (string address, boolean active) IP_Pool add_address (IP_Address address) IP_Pool add_addresses (array<IP_Address> addresses) IP_Pool remove_address (string address) IP_Pool remove_address (IP_Address address) IP_Pool remove_addresses (array<IP_Address> addresses) array<IP_Address> addresses ()
    # Add an IP address and set active to true.     IP_Pool add_address (string address)
    IP_Pool add_dhcp_setting (DHCP_Setting setting) IP_Pool add_dhcp_settings (array<DHCP_Setting> settings) IP_Pool remove_dhcp_setting (DHCP_Setting setting) IP_Pool remove_dhcp_settings (array<DHCP_Setting> settings) array<DHCP_Setting> dhcp_settings ()
    end

  • IP_Address

    class IP_Address < NetDB javadoc

    new (string address) new (IPaddress address) new (IPaddress address, boolean active) new (NetDB_Datastore datastore, string address) new (NetDB_Datastore datastore, IPaddress address) new (NetDB_Datastore datastore, IPaddress address, boolean active)
    IPaddress address (string address) IPaddress address (IPaddress address) IPaddress address ()
    IP_Address active (boolean active) boolean active ()
    IP_Address activate () IP_Address deactivate ()
    boolean is_active ()
    IP_Address add_name (string fqdn) IP_Address add_name (string name, string domain) IP_Address add_name (A_Name name) IP_Address add_names (array<A_Name> names) IP_Address remove_name (string fqdn) IP_Address remove_name (string name, string domain) IP_Address remove_name (A_Name name) IP_Address remove_names (array<A_Name> names) array<A_Name> names ()
    # Reserve **exactly** this address IP_Address reserve ()
    # Returns the set of reserved addresses. static array<IP_Address> reserve(string start, [int count=1, [boolean exact=false, [boolean contiguous=false]]]) static array<IP_Address> reserve(IPaddress start, [int count=1, [boolean exact=false, [boolean contiguous=false]]]) static array<IP_Address> reserve(NetDB_Datastore datastore, string start, [int count=1, [boolean exact=false, [boolean contiguous=false]]]) static array<IP_Address> reserve(NetDB_Datastore datastore, IPaddress start, [int count=1, [boolean exact=false, [boolean contiguous=false]]]) # Note that the active attribute for these addresses will be undefined. Committing a # record containing addresses with active undefined results in those addresses being # assigned the system default value, which is currently TRUE (and will probably stay # that way forever).
    boolean is_reserved ()
    IP_Address unreserve()
    end

  • Interface_IP_Address

    class Interface_IP_Address < IP_Address javadoc

    new (string address) new (IPaddress address) new (NetDB_Datastore datastore, string address) new (NetDB_Datastore datastore, IPaddress address)
    # Valid ptr_pref values are ALL or CLOSEST new (IPaddress address, boolean active, Enumeration ptr_pref) new (NetDB_Datastore datastore, IPaddress address, boolean active, Enumeration ptr_pref)
    # Returns the set of reserved addresses. static array<IP_Address> reserve(string start, [int count=1, [boolean exact=false, [boolean contiguous=false]]]) static array<IP_Address> reserve(IPaddress start, [int count=1, [boolean exact=false, [boolean contiguous=false]]]) # Note that the active and ptr_pref attributes for these addresses will be undefined. # Committing a record containing addresses with undefined attributes results in those # addresses being assigned the system default values, which are currently active=TRUE # and ptr_pref=ALL (active will probably always default to TRUE, but ptr_pref might # default to CLOSEST in the future).
    Interface_IP_Address ptr_pref (Enumeration ptr_pref) Enumeration ptr_pref ()
    end
  • Log

    # The Log is an integral part of the NetDB database. It is updated and maintained by the database. class Log < NetDB javadoc

    # Log Search static array<Log_Entry> full_search (Log_Search_Parameters parameters) static array<Log_Entry> full_search (NetDB_Datastore datastore, Log_Search_Parameters parameters)
    end

  • Log_Entry

    class Log_Entry < NetDB javadoc

    Enumeration ACTION { INSERT, DELETE, UPDATE } Enumeration RECORD_TYPE { ADMIN_TEAM, DOMAIN, NETWORK, NODE, OWNER, USER }
    timestamp date () array record_name () Long record_id () RECORD_TYPE record_type () array IP_address () State node_state () string user_name () string user_netid () ACTION action ()
    end


  • Name

    abstract class Name < NetDB javadoc

    Name name (string name) string name ()
    Name domain(string domain) Domain domain()
    Name full_name (string fqdn) Name full_name (string name, string domain) string full_name ()
    Name reserve () Name reserve (NetDB_Datastore datastore)
    boolean is_reserved ()
    unreserve ()
    end
  • Canonical

    abstract class Canonical < Name javadoc

    # Canonical names can have aliases.
    Canonical add_alias (string fqdn) Canonical add_alias (string name, string domain) Canonical add_alias (Alias alias) Canonical add_aliases (array<Alias> aliases)
    Canonical remove_alias (string fqdn) Canonical remove_alias (string name, string domain) Canonical remove_alias (Alias alias) Canonical remove_aliases (array<Alias> aliases)
    array<Alias> aliases ()
    end
  • A_Name

    class A_Name < Canonical javadoc

    new (string fqdn) new (string name, string domain)
    new (NetDB_Datastore datastore, string fqdn) new (NetDB_Datastore datastore, string name, string domain)
    A_name add_mx (string fqdn, int pref) A_name add_mx (string name, string domain, int pref) A_name add_mx (MX mx) A_name add_mxes (array<MX> mxes)
    A_name remove_mx (string fqdn) A_name remove_mx (string name, string domain) A_name remove_mx (MX mx) A_name remove_mxes (array<MX> mxes)
    array<MX> mxes ()
    end
  • TXT_Name

    class TXT_Name < Canonical javadoc

    new (string fqdn) new (string name, string domain)
    new (NetDB_Datastore datastore, string fqdn) new (NetDB_Datastore datastore, string name, string domain)
    end
  • MX

    class MX < Name javadoc

    new (string fqdn) new (string fqdn, int pref) new (string name, string domain) new (string name, string domain, int pref)
    new (NetDB_Datastore datastore, string fqdn) new (NetDB_Datastore datastore, string fqdn, int pref) new (NetDB_Datastore datastore, string name, string domain) new (NetDB_Datastore datastore, string name, string domain, int pref)
    MX pref (int pref) int pref ()
    end
  • Alias

    class Alias < Name javadoc

    new (string fqdn) new (string name, string domain)
    new (NetDB_Datastore datastore, string fqdn) new (NetDB_Datastore datastore, string name, string domain)
    end
  • Domain_Name

    class Domain_Name < Name javadoc

    new (string fqdn) new (string name, string domain)
    new (NetDB_Datastore datastore, string fqdn) new (NetDB_Datastore datastore, string name, string domain)
    end
  • Person

    # Person data comes from an external Directory. The external key is registry ID (regID). class Person < NetDB javadoc

    string regID () string netID () string name () string email () string phone () string lastname () string dirID () boolean active ()
    end
  • Consultant

    class Consultant < Person javadoc

    new () new (Person person, boolean primary) new (NetDB_Datastore datastore) new (NetDB_Datastore datastore, Person person, boolean primary)
    Consultant primary (boolean primary)
    Consultant set_primary () Consultant clear_primary ()
    boolean is_primary ()
    end
  • Directory_Person

    class Directory_Person < Person javadoc

    # Search the external Directory for Persons matching search_string. static array<Directory_Person> search(string search_string)
    # Look up a Person in the external Directory by NetID (NETID) or registry ID (REGID). static Directory_Person lookup(Enumeration by, string netid|regid)
    string department ()
    end
  • Record

    class Record < NetDB javadoc

    # Load a Record from the default or specified NetDB datastore. static abstract Record load (string handle) static abstract Record load (NetDB_Datastore datastore, string handle) static abstract Record load (Long record_id) static abstract Record load (NetDB_Datastore netdb, Long record_id)
    # Commit a Record to its NetDB datastore. If it isn't associated # with a datastore, the default datastore will be used. Throws an # unchanged record exception if the Record hasn't been changed. Record commit ()
    # Commit a Record to the specified NetDB datastore. abstract Record commit (NetDB_Datastore datastore)
    # Delete a Record from its NetDB datastore. Record delete ()
    # Delete a Record from the default or specified NetDB datastore. static abstract Record delete (string handle) static abstract Record delete (NetDB_Datastore datastore, string handle)
    # Check whether the operating user has the privileges necessary # to create, modify, and delete this record type. static abstract boolean hackable|writable () * Not sure this is necessary. Implement only if it is.
    end
  • Lockable

    class Lockable < Record javadoc

    # There is no explicit lock method. Locking is integrated into the load(), # delete(), and bind() methods to ensure consistency and atomicity.
    # Lock a Record (when lock is TRUE) then load it. static abstract Lockable load (boolean lock, string handle) static abstract Lockable load (NetDB_Datastore netdb, boolean lock, string handle) static abstract Lockable load (boolean lock, Long record_id) static abstract Lockable load (NetDB_Datastore netdb, boolean lock, Long record_id) # Reloading a locked Record does not change the lock, even if lock=FALSE; # reloading with lock=TRUE replaces the existing lock with a new lock.
    # Commit a Lockable Record to its NetDB datastore. If it isn't # associated with a datastore, the default datastore will be used. # Unlocks the record unless unlock is supplied and false. Throws # an unchanged record exception if the Record hasn't been changed. Record commit ([boolean unlock=true])
    # Commit a Lockable Record to the specified NetDB datastore. abstract Record commit (NetDB_Datastore datastore, [boolean unlock=true])
    Locakable unlock ()
    boolean is_locked ()
    # Lockable classes unlock themselves prior to rebinding. Lockable bind (NetDB_Datastore datastore)
    # Delete a Record from its NetDB datastore. # The record will be locked prior to deletion. Lockable delete ()
    # Delete a Record from the default or specified NetDB datastore. # The record will be locked prior to deletion. abstract Lockable delete (string handle) abstract Lockable delete (NetDB_Datastore datastore, string handle)
    # Lockable records (with the exception of Group) are owned by Groups. Lockable add_owner (string group_name) Lockable add_owner (Group group) Lockable add_owners (array<Group> groups) Lockable remove_owner (string group_name) Lockable remove_owner (Group group) Lockable remove_owners (array<Group> groups) array<Group> owners ()
    Lockable comment (string comment) string comment ()
    Person locked_by () Person created_by () Person modified_by ()
    timestamp locked_at () timestamp created_at () timestamp modified_at ()
    # Internal NetDB Identifier abstract Long id ()
    # Check whether the operating user has the privileges and group # membership necessary to lock this or the specified record. abstract boolean lockable () static abstract boolean lockable (string handle)
    # Simple search - searches on name, IP address, or (complete) hardware address. static array<Simple_Search_Result> search (string search_string) static array<Simple_Search_Result> search (NetDB_Datastore datastore, string search_string)
    # Full search static array<Lockable> full_search (Full_Search_Parameters parameters) static array<Lockable> full_search (NetDB_Datastore datastore, Full_Search_Parameters parameters)
    end
  • Node

    class Node < Lockable javadoc

    new () new (Department department, Location location, string room, State state, Model model) new (Department department, Location location, string room, State state, Model model, string comment, string expiration) new (Department department, Location location, string room, State state, Model model, string comment, timestamp expiration) new (NetDB_Datastore datastore) new (NetDB_Datastore datastore, Department department, Location location, string room, State state, Model model) new (NetDB_Datastore datastore, Department department, Location location, string room, State state, Model model, string comment, string expiration) new (NetDB_Datastore datastore, Department department, Location location, string room, State state, Model model, string comment, timestamp expiration)
    Node add_type (string type) Node add_type (Node_Type type) Node add_types (array<Node_Type> types) Node remove_type (string type) Node remove_type (Node_Type type) Node remove_types (array<Node_Type> types) array<Node_Type> types ()
    Node add_name (string fqdn) Node add_name (string name, string domain) Node add_name (A_Name name) Node add_names (array<A_Name> names) Node remove_name (string fqdn) Node remove_name (string name, string domain) Node remove_name (A_Name name) Node remove_names (array<A_Name> names) array<A_Name> names ()
    # Returns the set of Nodes that receive mail for A_Names on this node. # The Nodes will be incomplete and cannot be completed. Each will have # its handle and the names that receive mail for names on this Node. array<Node> mail_exchangers () * There are bugs in the database and front end that result in only   one name being returned and used. That will be fixed soon.
    # Returns all names on this Node (node names, interface names, interface # IP address names, and IPCP IP address names). Names returned can be # limited to those allowing MXes (ALLOW_MX) or aliases (ALLOW_ALIAS). array<A_Name> all_names () array<A_Name> all_names (A_Name.ALLOW allow)
    Node state (State state) State state ()
    Node department (string department) Node department (Department department) Department department ()
    Node location (string location) Node location (string site, string code) Node location (Location location) Location location ()
    Node room (string room) string room ()
    Node model (Model model) Model model ()
    Node add_OS (string os) Node add_OS (OS os) Node add_OSes (array<OS> OSes) Node remove_OS (string os) Node remove_OS (OS os) Node remove_OSes (array<OS> OSes) array<OS> OSes ()
    Node add_user (string user) Node add_user (Person user) Node add_users (array<Person> users) Node remove_user (string user) Node remove_user (Person user) Node remove_users (array<Person> users) array<Person> users ()
    Node add_admin (Person admin) Node add_admin (Admin_Team admin) Node add_admins (array<Record> admins) Node remove_admin (Person admin) Node remove_admin (Admin_Team admin) Node remove_admins (array<Record> admins) array<Record> admins ()
    # For all node types except Template. Node add_interface (Interface interface) Node add_interfaces (array<Interface> interfaces) Node remove_interface (Interface interface) Node remove_interfaces (array<Interface> interfaces) array<Interface> interfaces ()
    Node add_custom_field (Custom_Field custom_field) Node add_custom_fields (array<Custom_Field> custom_fields) Node remove_custom_field (Custom_Field custom_field) Node remove_custom_fields (array<Custom_Field> custom_fields) array<Custom_Field> custom_fields ()
    Node expiration_date (string expiration_date) Node expiration_date (timestamp expiration_date) timestamp expiration_date ()
    # Load a node by name, IP address, or hardware address. Node search_and_load (string search_string) Node search_and_load (boolean lock, string search_string) Node search_and_load (NetDB_Datastore datastore, string search_string) Node search_and_load (NetDB_Datastore datastore, boolean lock, string search_string) # Note: This is a convenience method combining the search() and # load() methods. If the search_string is a name, the search is # skipped, so it's as as efficient as the load() method in that # case.
    # Only for nodes with the Template type. Node address_space (string prefix) Node address_space (string prefix, int prefix_length) Node address_space (Address_Space address_space) Address_Space address_space ()
    # Only for nodes with the IP Connectivity Provider # type. These addresses are always active. Node add_address (IP_Address address) Node add_addresses (array<IP_Address> addresses) Node remove_address (IP_Address address) Node remove_addresses (array<IP_Address> addresses) array<IP_Address> addresses ()
    end
  • Network

    class Network < Lockable javadoc

    new () new (DHCP_Service dhcp_service, string comment) new (NetDB_Datastore datastore) new (NetDB_Datastore datastore, DHCP_Service dhcp_service, string comment)
    # Networks are currently limited to a single name Network add_name (string fqdn) Network add_name (string name, string domain) Network add_name (A_Name name) Network add_names (array<A_Name> names) Network remove_name (string fqdn) Network remove_name (string name, string domain) Network remove_name (A_Name name) Network remove_names (array<A_Name> names) array<A_Name> names ()
    # Return the next available VLAN number starting from start. static int next_available_vlan (int start) static int next_available_vlan (NetDB_Datastore datastore, int start)
    Network VLAN_area (string area) Network VLAN_area (VLAN_Area area) VLAN_area VLAN_area ()
    Network VLAN (int vlan_number) int VLAN ()
    Network dhcp_service (string service) Network dhcp_service (DHCP_Service service) DHCP_Service dhcp_service ()
    Network add_dhcp_setting (DHCP_Setting setting) Network add_dhcp_settings (array<DHCP_Setting> settings) Network remove_dhcp_setting (DHCP_Setting setting) Network remove_dhcp_settings (array<DHCP_Setting> settings) array<DHCP_Setting> dhcp_settings ()
    Network add_location (string location) Network add_location (Location location) Network add_locations (array<Location> locations) Network remove_location (string location) Network remove_location (Location location) Network remove_locations (array<Location> locations) array<Location> locations ()
    Network add_address_space (Address_Space address_space) Network add_address_spaces (array<Address_Space> address_spaces) Network remove_address_space (Address_Space address_space) Network remove_address_spaces (array<Address_Space> address_spaces) array<Address_Space> address_spaces ()
    # List the networks that the current operating user can modify. # Throws an error if no operating user has been specified. static array<Network> list () static array<Network> list (NetDB_Datastore datastore)
    # Move an Address Space from one Network to another. This is an # atomic operation that locks both Networks, moves the Address # Space, then commits and unlocks both Networks. static void move_address_space (string address_space_prefix,
                                    string source_network_handle,
                                    string destination_network_handle)
    end
  • Domain

    class Domain < Lockable javadoc

    new () new (Domain_Name name) new (Domain_Name name, boolean limited, boolean delegated, string comment) new (NetDB_Datastore datastore) new (NetDB_Datastore datastore, Domain_Name name) new (NetDB_Datastore datastore, Domain_Name name, boolean limited, boolean delegated, string comment)
    # Only the case of a Domain's name can be changed Domain name (Domain_Name name) Domain_Name name ()
    Domain limited (boolean limited) boolean limited ()
    Domain delegated (boolean delegated) boolean delegated ()
    Domain set_limited () Domain set_delegated () Domain clear_limited () Domain clear_delegated ()
    boolean is_limited () boolean is_delegated ()
    # Domains, especially delegated domains, should have a point of contact. Domain add_admin (Person admin) Domain add_admin (Admin_Team admin) Domain add_admins (array<Record> admins) Domain remove_admin (Person admin) Domain remove_admin (Admin_Team admin) Domain remove_admins (array<Record> admins) array<Record> admins ()
    # Delegation Signer records for delegated domains. Domain add_DS_record (DS_record record) Domain add_DS_records (array<DS_records> records) Domain remove_DS_record (DS_record record) Domain remove_DS_records (array<DS_records> records) array<DS_records> DS_records ()
    # Nameservers for delegated domains. Domain add_nameserver (string nameserver) Domain add_nameservers (array<string> nameservers) Domain remove_nameserver (string nameserver) Domain remove_nameservers (array<string> nameservers) array<string> nameservers ()
    # Assign names in the domain groups * method names not descriptive enough Domain add_allow_group (string group_name) Domain add_allow_group (Group group) Domain add_allow_groups (array<Group> groups) Domain remove_allow_group (string group_name) Domain remove_allow_group (Group group) Domain remove_allow_groups (array<Group> groups) array<Group> allow_groups ()
    # Use the domain name as another name * method names not descriptive enough Domain add_use_group (string group_name) Domain add_use_group (Group group) Domain add_use_groups (array<Group> groups) Domain remove_use_group (string group_name) Domain remove_use_group (Group group) Domain remove_use_groups (array<Group> groups) array<Group> use_groups ()
    * The names of the add/remove_*_group methods don't clearly reflect * how the groups are used. And I'm having trouble coming up with * better names. Maybe we should call them access groups and specify * the access type in a parameter thusly:
    # Permissions to create names in a domain or use a domain name as another # type of name are controlled via groups. Valid access_type values are # CREATE_NAMES_IN_DOMAIN and USE_DOMAIN_AS_NAME. Domain grant_access (string group_name, Enumeration access_type) Domain grant_access (Group group, Enumeration access_type) Domain grant_access (array<Group> groups, Enumeration access_type) Domain revoke_access (string group_name, Enumeration access_type) Domain revoke_access (Group group, Enumeration access_type) Domain revoke_access (array<Group> groups, Enumeration access_type) array<Group> get_acl (Enumeration access_type)
    # List the domains that the current operating user can create names in. If # no operating user has been specified, list them all. static array<Domain> list () static array<Domain> list (NetDB_Datastore datastore)
    # List all domains (equivalent to list()/list(datastore) if all is FALSE) static array<Domain> list (boolean all) static array<Domain> list (NetDB_Datastore datastore, boolean all)
    # Check if the operating user can create names in this domain. boolean usable ()
    # Check if the operating user can use this domain as another type of name. boolean usable_as_name ()
    end
  • TXT_Record

    class TXT_Record < Lockable javadoc

    new () new (TXT_Name name) new (TXT_Name name, string comment) new (NetDB_Datastore datastore) new (NetDB_Datastore datastore, TXT_Name name) new (NetDB_Datastore datastore, TXT_Name name, string comment)
    TXT_Name name ()
    TXT_Record comment (String comment) String comment ()
    # A TXT_Record must have an administrator. TXT_Record add_admin (Person admin) TXT_Record add_admin (Admin_Team admin) TXT_Record add_admins (array<Record> admins) TXT_Record remove_admin (Person admin) TXT_Record remove_admin (Admin_Team admin) TXT_Record remove_admins (array<Record> admins) array<Record> admins ()
    TXT_Record add_value (TXT_value value) TXT_Record add_values (array<TXT_value> values) TXT_Record remove_value (TXT_value value) TXT_Record remove_values (array<TXT_value> values) array<string> values ()
  • User

    class User < Lockable javadoc

    new () new (Person person, boolean active, Domain default_domain) new (Person person, boolean active, Domain default_domain, Group default_group, IPaddress starting_address, boolean all_groups, boolean all_records, string comment) new (NetDB_Datastore datastore) new (NetDB_Datastore datastore, Person person, boolean active, Domain default_domain) new (NetDB_Datastore datastore, Person person, boolean active, Domain default_domain, Group default_group, IPaddress starting_address, boolean all_groups, boolean all_records, string comment)
    User identity (Person person) Person identity ()
    string name () string netID () static string netID (string OAuthID)
    User active (boolean active) boolean active ()
    User activate () User deactivate ()
    User default_domain (Domain domain) Domain default_domain ()
    User default_group (Group group) Group default_group ()
    User starting_address (IPaddress address) IPaddress starting_address ()
    # Defaults to FALSE User all_groups (boolean all_groups) boolean all_groups ()
    User grant_all_groups () User revoke_all_groups ()
    # Defaults to FALSE User all_records (boolean all_records) boolean all_records ()
    User grant_all_records () User revoke_all_records ()
    User add_privilege (string privilege) User grant_privilege (Privilege privilege) User grant_privileges (array<Privilege> privileges) User revoke_privilege (string privilege) User revoke_privilege (Privilege privilege) User revoke_privileges (array<Privilege> privileges) array<Privilege> privileges ()
    User add_department (string department) User add_department (Department department) User add_departments (array<Department> departments) User remove_department (string department) User remove_department (Department department) User remove_departments (array<Department> departments) array<Department> departments ()
    User oauthID (string ID) string oauthID ()
    # Sets the last login time of the specified user to the current time and # returns that user. Note: When using the RMI the last login time is set # when the NetDB_Datastore is created and cannot be changed. Trying to # do so will result in an error. static User login (string handle) static User login (NetDB_Datastore datastore, string handle) timestamp last_login ()
    end
  • Admin_Team

    class Admin_Team < Lockable javadoc

    new () new (string name, string email, string phone) new (string name, string email, string phone, string comment) new (NetDB_Datastore datastore) new (NetDB_Datastore datastore, string name, string email, string phone) new (NetDB_Datastore datastore, string name, string email, string phone, string comment)
    Admin_Team name (string name) string name ()
    Admin_Team email (string email) string email ()
    Admin_Team phone (string phone) string phone ()
    Admin_Team add_member (string member) Admin_Team add_member (Person member) Admin_Team add_members (array<Person> members) Admin_Team remove_member (string member) Admin_Team remove_member (Person member) Admin_Team remove_members (array<Person> members) array<Person> members ()
    Admin_Team add_department (string department) Admin_Team add_department (Department department) Admin_Team add_departments (array<Department> departments) Admin_Team remove_department (string department) Admin_Team remove_department (Department department) Admin_Team remove_departments (array<Department> departments) array<Department> departments ()
    end
  • Group

    class Group < Lockable javadoc

    new () new (string name) new (string name, string comment) new (NetDB_Datastore datastore) new (NetDB_Datastore datastore, string name) new (NetDB_Datastore datastore, string name, string comment)
    Group name (string name) string name ()
    # List the records that the current operating user has access to. If no # operating user has been specified, list them all. static array<Group> list () static array<Group> list (NetDB_Datastore datastore)
    # List all records (equivalent to list()/list(datastore) if all is FALSE) static array<Group> list (boolean all) static array<Group> list (NetDB_Datastore datastore, boolean all)
    end
  • Department

    class Department < Record javadoc

    new () new (string name) new (string name, string regid) new (NetDB_Datastore datastore) new (NetDB_Datastore datastore, string name) new (NetDB_Datastore datastore, string name, string regid)
    Department name (string name) string name ()
    Department regID (string regid) string regID ()
    # List all departments or all departments matching filter. static array<Department> list () static array<Department> list (string filter) static array<Department> list (NetDB_Datastore datastore) static array<Department> list (NetDB_Datastore datastore, string filter)
    Department add_consultant (Consultant consultant) Department add_consultants (array<Consultant> consultants) Department remove_consultant (Consultant consultant) Department remove_consultant (array<Consultant> consultants) array<Consultant> consultants ()
    # Replace this department with the specified department. Returns the # department supplanting this department (this department is history, # after all). Department supplant(Department department)
    end
  • DHCP_Option

    class DHCP_Option < Record javadoc

    new () new (string name, Enumeration data_type) new (string name, Enumeration data_type, Enumeration type) new (NetDB_Datastore datastore) new (NetDB_Datastore datastore, string name, Enumeration data_type) new (NetDB_Datastore datastore, string name, Enumeration data_type, Enumeration type)
    DHCP_Option name (string name) string name ()
    # Valid data types are FLAG, HOST, INTEGER, KEYWORD, and STRING. DHCP_Option data_type(Enumeration data_type) Enumeration data_type()
    # Possible types are OPTION and PARAMETER (default). DHCP_Option type(Enumeration type) Enumeration type()
    # DHCP options apply to scopes. Scopes are DHCP_SERVICE, NETWORK, # ADDRESS_SPACE, and INTERFACE. Unused and untested. DHCP_Option add_application (Enumeration scope) DHCP_Option add_applications (array<Enumeration> scopes) DHCP_Option remove_application (Enumeration scope) DHCP_Option remove_applications (array<Enumeration> scopes) array<Enumeration> applications ()
    # List all DHCP options or DHCP options applicable to the specified scope. static array<DHCP_Option> list () static array<DHCP_Option> list (Enumeration scope) static array<DHCP_Option> list (NetDB_Datastore datastore) static array<DHCP_Option> list (NetDB_Datastore datastore, Enumeration scope)
    end
  • DHCP_Service

    # The data for this class is rarely added or modified so only the # constructor and getter methods have been implemented (even though # a new object cannot be saved the constructor methods are useful # for comparisons). This class's commit() and delete() methods # throw a NOT IMPLEMENTED exception.
    class DHCP_Service < Record javadoc

    new () new (string name) new (string name, string comment) new (NetDB_Datastore datastore) new (NetDB_Datastore datastore, string name) new (NetDB_Datastore datastore, string name, string comment)
    DHCP_Service name(string name) string name ()
    DHCP_Service comment(string comment) string comment ()
    # List all DHCP services static array<DHCP_Service> list () static array<DHCP_Service> list (NetDB_Datastore datastore)
    DHCP_Service add_dhcp_setting (DHCP_Setting setting) DHCP_Service add_dhcp_settings (array<DHCP_Setting> settings) DHCP_Service remove_dhcp_setting (DHCP_Setting setting) DHCP_Service remove_dhcp_settings (array<DHCP_Setting> settings) array<DHCP_Setting> dhcp_settings ()
    Person modified_by () timestamp modified_at ()
    end
  • Interface_Type

    # The data for this class is rarely added or modified so only the # constructor and getter methods have been implemented (even though # a new object cannot be saved the constructor methods are useful # for comparisons). This class's commit() and delete() methods # throw a NOT IMPLEMENTED exception.
    class Interface_Type < Record javadoc

    new () new (string name) new (NetDB_Datastore datastore) new (NetDB_Datastore datastore, string name)
    # List all interface types static array<Interface_Type> list () static array<Interface_Type> list (NetDB_Datastore datastore)
    Interface_Type name(string name) string name ()
    # We have a comment stored in the database, but there is no way to access it. # Right now, the only "real" method in the database package, and the only way # to find out if an interface type exists, is verify_or_die (...) string comment ()
    end
  • Location

    class Location < Record javadoc

    new () new (string name, string site, string code) new (NetDB_Datastore datastore) new (NetDB_Datastore datastore, string name, string site, string code)
    Location name (string name) Location site (string name) Location code (string code)
    string name () string site () string code ()
    # List all locations or all locations matching filter. static array<Location> list () static array<Location> list (string filter) static array<Location> list (NetDB_Datastore datastore) static array<Location> list (NetDB_Datastore datastore, string filter)
    end
  • Make

    class Make < Record javadoc

    new () new (string name) new (NetDB_Datastore datastore) new (NetDB_Datastore datastore, string name)
    Make name (string name) string name ()
    # List all makes static array<Make> list () static array<Make> list (NetDB_Datastore datastore)
    end
  • Model

    class Model < Record javadoc

    new () new (string name, string make) new (string name, string make, string model_type) new (string name, Make make) new (string name, Make make, Model_Type model_type)
    new (NetDB_Datastore datastore) new (NetDB_Datastore datastore, string name, string make) new (NetDB_Datastore datastore, string name, string make, string model_type) new (NetDB_Datastore datastore, string name, Make make) new (NetDB_Datastore datastore, string name, Make make, Model_Type model_type)
    # Load a Model from the default or specified NetDB datastore. # Model does not have the Record load() methods; just these (i.e., the # Make is required to load a Model). static abstract Record load (string make, string model) static abstract Record load (NetDB_Datastore datastore, string make, string model)
    # Delete a Record from the default or specified NetDB datastore. # As with load(), these are the only delete() methods on Model. static abstract Record delete (string make, string model) static abstract Record delete (NetDB_Datastore datastore, string make, string model)
    Model name (string name) string name ()
    Model make (string make) Model make (Make make) Make make ()
    Model model_type (string model_type) Model model_type (Model_Type model_type) Model_Type model_type ()
    # List all models or all models matching filter. static array<Model> list () static array<Model> list (string filter) static array<Model> list (NetDB_Datastore datastore) static array<Model> list (NetDB_Datastore datastore, string filter)
    Person modified_by () timestamp modified_at ()
    # Replace this model with the specified model. Returns the model # supplanting this model (this model is history, after all). Model supplant(Model model)
    end
  • Model_Type

    # The data for this class is rarely added or modified so only the # constructor and getter methods have been implemented (even though # a new object cannot be saved the constructor methods are useful # for comparisons). This class's commit() and delete() methods # throw a NOT IMPLEMENTED exception.
    class Model_Type < Record javadoc

    new () new (string name) new (string name, string comment) new (NetDB_Datastore datastore) new (NetDB_Datastore datastore, string name) new (NetDB_Datastore datastore, string name, string comment)
    string name () string comment ()
    Model_Type name (string name) Model_Type comment (string comment)
    # List all model types static array<Model_Type> list () static array<Model_Type> list (NetDB_Datastore datastore)
    end
  • Node_Type

    # The data for this class is rarely added or modified so only the # constructor and getter methods have been implemented (even though # a new object cannot be saved the constructor methods are useful # for comparisons). This class's commit() and delete() methods # throw a NOT IMPLEMENTED exception.
    class Node_Type < Record javadoc

    new () new (string name) new (NetDB_Datastore datastore) new (NetDB_Datastore datastore, string name)
    # List the records that the current operating user has access to. If no # operating user has been specified, list them all. static array<Node_Type> list () static array<Node_Type> list (NetDB_Datastore datastore)
    # List all records (equivalent to list()/list(datastore) if all is FALSE) static array<Node_Type> list (boolean all) static array<Node_Type> list (NetDB_Datastore datastore, boolean all)
    string name () string plural () string abbrev ()
    Node_Type name (string name) Node_Type plural (string plural) Node_Type abbrev (string abbrev)
    # Suggested presentation order int rank () Node_Type rank (Number rank)
    string comment () Node_Type comment (string comment)
    * Seems like this is used by the middleware, but not the middleware users string extkey ()
    Privilege privilege () Node_Type privilege (Privilege privilege)
    end
  • OS

    class OS < Record javadoc

    new () new (string name) new (string name, string comment) new (NetDB_Datastore datastore) new (NetDB_Datastore datastore, string name) new (NetDB_Datastore datastore, string name, string comment)
    OS name (string name) string name ()
    OS comment (string name) string comment ()
    # List all OSes or all OSes matching filter. static array<OS> list () static array<OS> list (string filter) static array<OS> list (NetDB_Datastore datastore) static array<OS> list (NetDB_Datastore datastore, string filter)
    Person modified_by () timestamp modified_at ()
    # Replace this OS with the specified OS. Returns the OS # supplanting this OS (this OS is history, after all). OS supplant(OS os)
    end
  • Privilege

    # The data for this class is rarely added or modified so only the # constructor and getter methods have been implemented (even though # a new object cannot be saved the constructor methods are useful # for comparisons). This class's commit() and delete() methods # throw a NOT IMPLEMENTED exception.
    class Privilege < Record javadoc

    new () new (string name) new (NetDB_Datastore datastore) new (NetDB_Datastore datastore, string name)
    string name () string display_name () string comment () boolean default ()
    Privilege name (string name) Privilege comment (string comment) Privilege display_name (string display_name) Privilege default (boolean default)
    # List privileges static array<Privilege> list () static array<Privilege> list (NetDB_Datastore datastore)
    end
  • State

    class State < Record javadoc

    # List the records that the current operating user has access to. If no # operating user has been specified, list them all. static array<State> list () static array<State> list (NetDB_Datastore datastore)
    # List all records (equivalent to list()/list(datastore) if all is FALSE) static array<State> list (boolean all) static array<State> list (NetDB_Datastore datastore, boolean all)
    State name (string name) string name ()
    State denyDNS (boolean denyDNS) boolean denyDNS ()
    State denyDHCP (boolean denyDHCP) boolean denyDHCP ()
    State comment (string comment) string comment ()
    # Suggested presentation order State rank (Number rank) int rank ()
    State privilege (string privilege) State privilege (Privilege privilege) Privilege privilege ()
    # Check if the operating user can use this state. boolean usable ()
    end
  • VLAN_Area

    # The data for this class is rarely added or modified so only the # constructor and getter methods have been implemented (even though # a new object cannot be saved the constructor methods are useful # for comparisons). This class's commit() and delete() methods # throw a NOT IMPLEMENTED exception.
    class VLAN_Area < Record javadoc

    new () new (string name) new (string name, string comment) new (NetDB_Datastore datastore) new (NetDB_Datastore datastore, string name) new (NetDB_Datastore datastore, string name, Number rank, string comment)
    VLAN_Area name(string name) string name ()
    VLAN_Area comment(string comment) string comment ()
    # Suggested presentation order VLAN_Area rank (Number rank) Integer rank ()
    # List all VLAN areas static array<VLAN_Area> list () static array<VLAN_Area> list (NetDB_Datastore datastore)
    end
  • TXT_Value

    class TXT_Value < NetDB javadoc

    new () new (string value) new (string value, string comment, timestamp expiration_date) new (NetDB_Datastore datastore) new (NetDB_Datastore datastore, string value) new (NetDB_Datastore datastore, string value, string comment, timestamp expiration_date)
    # A TXT_Value may have a point of contact. TXT_Value add_admin (Person admin) TXT_Value add_admin (Admin_Team admin) TXT_Value add_admins (array<Record> admins) TXT_Value remove_admin (Person admin) TXT_Value remove_admin (Admin_Team admin) TXT_Value remove_admins (array<Record> admins) array<Record> admins ()
    TXT_Value comment (string comment) string comment ()
    TXT_Value expiration_date (string expiration_date) TXT_Value expiration_date (timestamp expiration_date) timestamp expiration_date ()
    TXT_Value value (string value) string value ()
    end
  • Custom_Field

    class Custom_Field javadoc

    new () new (string name) new (string name, string value)
    Custom_Field name (string name) string name ()
    Custom_Field value (string value) string value ()
    # Returns a formatted version of the object. Formats are FULL (default) # WHOIS (FULL minus sensitive / unimportant fields), HTML (FULL with CSS # tags for label and data), and WHOIS_HTML (WHOIS with CSS tags). string toString() string toString(Enumeration format)
    end
  • DHCP_Setting

    class DHCP_Setting javadoc

    new () new (DHCP_Option option) new (string option, string value) new (DHCP_Option option, string value)
    DHCP_Setting option (DHCP_Option option) DHCP_Option option ()
    DHCP_Setting value (string value) string value ()
    # Returns a formatted version of the object. Formats are FULL (default) # WHOIS (FULL minus sensitive / unimportant fields), HTML (FULL with CSS # tags for label and data), and WHOIS_HTML (WHOIS with CSS tags). string toString() string toString(Enumeration format)
    end

  • Simple_Search_Result

    class Simple_Search_Result javadoc

    string handle ()
    end
  • Admin_Team_SS_Result

    class Admin_Team_SS_Result < Simple_Search_Result javadoc

    string name ()
    end
  • Domain_SS_Result

    class Domain_SS_Result < Simple_Search_Result javadoc

    string name ()
    end
  • Group_SS_Result

    class Group_SS_Result < Simple_Search_Result javadoc

    string name ()
    end
  • Network_SS_Result

    class Network_SS_Result < Simple_Search_Result javadoc

    # Fully-qualified Network name (same as handle()). If a Network has more # than one name this will be first in case-blind alphabetical order. string network_name ()
    # This may be an IP or a Prefix. string IP ()
    # The name of the Network or DHCP address that matched a name search string, # or the name of the Network or DHCP address whose prefix or IP matched an # IP search string. If this name is in the operating user's default domain # it will be returned unqualified, i.e., stripped of that domain. string name ()
    # Type of the name - NETWORK or DHCP_ADDRESS Simple_Search_Result.NAME_TYPE name_type ()
    string comment ()
    end
  • Node_SS_Result

    class Node_SS_Result < Simple_Search_Result javadoc

    # Fully-qualified node name (same as handle()). If a Node has more # than one name this will be first in case-blind alphabetical order. string node_name () Long node_id ()
    # Type of search performed - NAME, IP, or HARDWARE_ADDRESS. Enumeration search_type()
    # A name whose relation to the node depends on the type of search: #   Name search: name matching the search string #   IP address search: name closest to the IP address (ADDRESS, INTERFACE, or NODE name) #   HW address search: name closest to the interface (INTERFACE or NODE name) # If this name is in the operating user's default domain it will be # returned unqualified, i.e., stripped of that domain. string name ()
    # Type of the name - possible values are NODE, ALIAS, MX, INTERFACE, ADDRESS, # and IPC_ADDRESS. Simple_Search_Result.NAME_TYPE name_type ()
    # Convenience method that returns the same value as node_name(), default domain # adjusted, for all but the ALIAS and MX name types. For ALIAS names it returns # the canonical name the alias points to. MX names have the preference appended # to the name in parenthesis, e.g., "bacon (10)". string display_name ()
    # An IP address whose relation to the node depends on the type of search: #   Name search: The lowest active IP address associated with the name #   IP address search: The IP address matching the search string #   HW address search: The lowest active IP address on that interface. string IP ()
    # Type of IP address returned. Types are INTERFACE_ADDRESS and IPC_ADDRESS. Enumeration IP_type ()
    string department () string make_and_model () string OS ()
    # This only has a value when the name type is 'ALIAS'. string canonical_name ()
    # These only have values when the name type is 'MX'. string received_by () string received_by_fullname () Long preference ()
    array <Node_Type> types ()
    end
  • TXT_Record_SS_Result

    class TXT_Record_SS_Result < Simple_Search_Result javadoc

    # Fully-qualified TXT record name (same as handle()). string TXT_record_name () Long TXT_record_id ()
    # The name matching the search string. If this name is in the operating user's # default domain it will be returned unqualified, i.e., stripped of that domain. string name ()
    # Type of the name - possible values are TXT and ALIAS. Simple_Search_Result.NAME_TYPE name_type ()
    # Convenience method that returns a name, default domain adjusted, depending on # the name type. For type TXT the value is the same as TXT_record_name (); for # type ALIAS the value is the canonical name the alias points to. string display_name ()
    # This only has a value when the name type is 'ALIAS'. In that case it returns # the fully-qualified canonical name the alias points to. string canonical_name ()
    string value ()
    end
  • User_SS_Result

    class User_SS_Result < Simple_Search_Result javadoc

    # User netID (same as handle()). string netID () string name () string regID ()
    end

  • FS_Boolean

    # Several fields within Full Search are Boolean. Full Search allows the user # to search for either a specific state, or either state. The FS_Boolean class # has the required static values to fill this need. class FS_Boolean javadoc

    static FS_Boolean EITHER static FS_Boolean FALSE static FS_Boolean TRUE
    string toString () int value ()
    end
  • Log_Search_Parameters

    class Log_Search_Parameters javadoc

    new ()
    Log_Search_Parameters after (string date) Log_Search_Parameters after (string date, boolean include_data) string after ()
    Log_Search_Parameters before (string date) Log_Search_Parameters before (string date, boolean include_data) string action_before ()
    Log_Search_Parameters include_date (boolean include_data) boolean include_date ()
    Log_Search_Parameters actions (array<Log_Entry.ACTION> actions) Log_Search_Parameters actions (array<Log_Entry.ACTION> actions, boolean include_data) array<Log_Entry.ACTION> actions ()
    Log_Search_Parameters include_actions (boolean include_data) boolean include_actions ()
    Log_Search_Parameters IP_address (string address) Log_Search_Parameters IP_address (string address, boolean include_data) string IP_address ()
    Log_Search_Parameters include_IP_address (boolean include_data) boolean include_IP_address ()
    Log_Search_Parameters node_state (string state) Log_Search_Parameters node_state (string state, boolean include_data) string node_state ()
    Log_Search_Parameters include_node_state (boolean include_data) boolean include_node_state ()
    Log_Search_Parameters record_id (string record_id) Log_Search_Parameters record_id (string record_id, boolean include_data) string record_id ()
    Log_Search_Parameters include_record_id (boolean include_data) boolean include_record_id ()
    Log_Search_Parameters record_name (string name) Log_Search_Parameters record_name (string name, boolean include_data) string record_name ()
    Log_Search_Parameters include_record_name (boolean include_data) boolean include_record_name ()
    Log_Search_Parameters record_type (Log_Entry.RECORD_TYPE type) Log_Search_Parameters record_type (Log_Entry.RECORD_TYPE type, boolean include_data) Log_Entry.RECORD_TYPE record_type ()
    Log_Search_Parameters include_record_type (boolean include_data) boolean include_record_type ()
    Log_Search_Parameters user_name (string name) Log_Search_Parameters user_name (string name, boolean include_data) string user_name ()
    Log_Search_Parameters user_netid (string netid) Log_Search_Parameters user_netid (string netid, boolean include_data) string user_netid ()
    Log_Search_Parameters include_user (boolean include_data) boolean include_user ()
    # Generate a Hashtable with the appropriate values for the legacy Full # Search parser. This method will disappear with legacy Full Search. Hashtable<string,string> legacy_search_params ()
    end
  • Full_Search_Parameters

    # Full_Search_Parameters handles the comment, owner, and created/modified by/at # methods for the Full Search classes that inherit from Lockable. class Full_Search_Parameters javadoc

    Full_Search_Parameters comment (string comment) Full_Search_Parameters comment (string comment, boolean include_data) string comment ()
    Full_Search_Parameters include_comment (boolean include_data) boolean include_comment ()
    Full_Search_Parameters created_after_date (string date) Full_Search_Parameters created_after_date (string date, boolean include_data) string created_after_date ()
    Full_Search_Parameters created_before_date (string date) Full_Search_Parameters created_before_date (string date, boolean include_data) string created_before_date ()
    Full_Search_Parameters include_created_at (boolean include_data) boolean include_created_at ()
    Full_Search_Parameters created_by_name (string name) Full_Search_Parameters created_by_name (string name, boolean include_data) string created_by_name ()
    Full_Search_Parameters created_by_netid (string netid) Full_Search_Parameters created_by_netid (string netid, boolean include_data) string created_by_netid ()
    Full_Search_Parameters include_created_by (boolean include_data) boolean include_created_by ()
    Full_Search_Parameters modified_after_date (string date) Full_Search_Parameters modified_after_date (string date, boolean include_data) string modified_after_date ()
    Full_Search_Parameters modified_before_date (string date) Full_Search_Parameters modified_before_date (string date, boolean include_data) string modified_before_date ()
    Full_Search_Parameters include_modified_at (boolean include_data) boolean include_modified_at ()
    Full_Search_Parameters modified_by_name (string name) Full_Search_Parameters modified_by_name (string name, boolean include_data) string modified_by_name ()
    Full_Search_Parameters modified_by_netid (string netid) Full_Search_Parameters modified_by_netid (string netid, boolean include_data) string modified_by_netid ()
    Full_Search_Parameters include_modified_by (boolean include_data) boolean include_modified_by ()
    Full_Search_Parameters owner (string group) Full_Search_Parameters owner (string group, boolean include_data) string owner ()
    Full_Search_Parameters include_owner (boolean include_data) boolean include_owner ()
    # Modify search_params to include the appropriate comment, owner, and created/modified # at/by values for the legacy Full Search parser. This method shouldn't be called by the # end user as each child calls this method as a part of its own legacy_search_params (). void legacy_search_params (Hashtable<string,string> search_params)
    end
  • Admin_Team_FS_Parameters

    class Admin_Team_FS_Parameters < Full_Search_Parameters javadoc

    new ()
    Admin_Team_FS_Parameters department (string department) Admin_Team_FS_Parameters department (string department, boolean include_data) string department ()
    Admin_Team_FS_Parameters include_department (boolean include_data) boolean include_department ()
    Admin_Team_FS_Parameters email (string email) Admin_Team_FS_Parameters email (string email, boolean include_data) string email ()
    Admin_Team_FS_Parameters include_email (boolean include_data) boolean include_email ()
    Admin_Team_FS_Parameters member_name (string name) Admin_Team_FS_Parameters member_name (string name, boolean include_data) string member_name ()
    Admin_Team_FS_Parameters include_member_name (boolean include_data) boolean include_member_name ()
    Admin_Team_FS_Parameters member_netid (string netid) Admin_Team_FS_Parameters member_netid (string netid, boolean include_data) string member_netid ()
    Admin_Team_FS_Parameters include_member_netid (boolean include_data) boolean include_member_netid ()
    Admin_Team_FS_Parameters name (string name) Admin_Team_FS_Parameters name (string name, boolean include_data) string name ()
    Admin_Team_FS_Parameters include_name (boolean include_data) boolean include_name ()
    Admin_Team_FS_Parameters phone (string phone) Admin_Team_FS_Parameters phone (string phone, boolean include_data) string phone ()
    Admin_Team_FS_Parameters include_phone (boolean include_data) boolean include_phone ()
    # Generate a Hashtable with the appropriate values for the legacy Full # Search parser. This method will disappear with legacy Full Search. Hashtable<string,string> legacy_search_params ()
    end
  • Domain_FS_Parameters

    class Domain_FS_Parameters < Full_Search_Parameters javadoc

    new ()
    Domain_FS_Parameters admin_name (string name) Domain_FS_Parameters admin_name (string name, boolean include_data) string admin_name ()
    Domain_FS_Parameters admin_netid (string netid) Domain_FS_Parameters admin_netid (string netid, boolean include_data) string admin_netid ()
    Domain_FS_Parameters admin_team (string team_name) Domain_FS_Parameters admin_team (string team_name, boolean include_data) string admin_team ()
    Domain_FS_Parameters include_administrators (boolean include_data) boolean include_administrators ()
    Domain_FS_Parameters create_names_in (string group) Domain_FS_Parameters create_names_in (string group, boolean include_data) string create_names_in ()
    Domain_FS_Parameters include_create_names_in (boolean include_data) boolean include_create_names_in ()
    Domain_FS_Parameters delegated (FS_Boolean delegated) Domain_FS_Parameters delegated (FS_Boolean delegated, boolean include_data) FS_Boolean delegated ()
    Domain_FS_Parameters include_delegated (boolean include_data) boolean include_delegated ()
    Domain_FS_Parameters ds_record_algorithm (int algorithm) Domain_FS_Parameters ds_record_algorithm (int algorithm, boolean include_data) FS_Boolean ds_record_algorithm ()
    Domain_FS_Parameters ds_record_digest (string digest) Domain_FS_Parameters ds_record_digest (string digest, boolean include_data) string ds_record_digest ()
    Domain_FS_Parameters ds_record_digest_type (int digest_type) Domain_FS_Parameters ds_record_digest_type (int digest_type, boolean include_data) FS_Boolean ds_record_digest_type ()
    Domain_FS_Parameters ds_record_key_tag (int key_tag) Domain_FS_Parameters ds_record_key_tag (int key_tag, boolean include_data) FS_Boolean ds_record_key_tag ()
    Domain_FS_Parameters limited (FS_Boolean limited) Domain_FS_Parameters limited (FS_Boolean limited, boolean include_data) FS_Boolean limited ()
    Domain_FS_Parameters include_limited (boolean include_data) boolean include_limited ()
    Domain_FS_Parameters name (string domain) Domain_FS_Parameters name (string domain, boolean include_data) string name ()
    Domain_FS_Parameters include_name (boolean include_data) boolean include_name ()
    Domain_FS_Parameters publish_ds_record (FS_Boolean publish) Domain_FS_Parameters publish_ds_record (FS_Boolean publish, boolean include_data) FS_Boolean publish ()
    Domain_FS_Parameters use_as_name (string group) Domain_FS_Parameters use_as_name (string group, boolean include_data) string use_as_name ()
    Domain_FS_Parameters include_use_as_name (boolean include_data) boolean include_use_as_name ()
    # Generate a Hashtable with the appropriate values for the legacy Full # Search parser. This method will disappear with legacy Full Search. Hashtable<string,string> legacy_search_params ()
    end
  • Group_FS_Parameters

    class Group_FS_Parameters < Full_Search_Parameters javadoc

    new ()
    Group_FS_Parameters name (string name) Group_FS_Parameters name (string name, boolean include_data) string name ()
    Group_FS_Parameters include_name (boolean include_data) boolean include_name ()
    # Generate a Hashtable with the appropriate values for the legacy Full # Search parser. This method will disappear with legacy Full Search. Hashtable<string,string> legacy_search_params ()
    end
  • Network_FS_Parameters

    class Network_FS_Parameters < Full_Search_Parameters javadoc

    new ()
    Network_FS_Parameters address_space (string prefix) Network_FS_Parameters address_space (string prefix, boolean include_data) string address_space ()
    Network_FS_Parameters include_address_space (boolean include_data) boolean include_address_space ()
    Network_FS_Parameters address_space_comment (string comment) Network_FS_Parameters address_space_comment (string comment, boolean include_data) string address_space_comment ()
    Network_FS_Parameters include_address_space_comment (boolean include_data) boolean include_address_space_comment ()
    Network_FS_Parameters address_space_group (string group) Network_FS_Parameters address_space_group (string group, boolean include_data) string address_space_group ()
    Network_FS_Parameters include_address_space_group (boolean include_data) boolean include_address_space_group ()
    Network_FS_Parameters address_space_dhcp_setting (string dhcp_setting) Network_FS_Parameters address_space_dhcp_setting (string dhcp_setting, boolean include_data) string address_space_dhcp_setting ()
    Network_FS_Parameters include_address_space_dhcp_setting (boolean include_data) boolean include_address_space_dhcp_setting ()
    Network_FS_Parameters include_low_res (boolean include_data) boolean include_low_res ()
    Network_FS_Parameters include_high_res (boolean include_data) boolean include_high_res ()
    # The code of Location site-code Network_FS_Parameters code (string code) Network_FS_Parameters code (string code, boolean include_data) string code ()
    Network_FS_Parameters include_code (boolean include_data) boolean include_code ()
    Network_FS_Parameters dhcp_address (string address) Network_FS_Parameters dhcp_address (string address, boolean include_data) string dhcp_address ()
    Network_FS_Parameters include_dhcp_address (boolean include_data) boolean include_dhcp_address ()
    Network_FS_Parameters dhcp_address_active (FS_boolean active) Network_FS_Parameters dhcp_address_active (FS_boolean active, boolean include_data) FS_boolean dhcp_address_active ()
    Network_FS_Parameters include_dhcp_address_active (boolean include_data) boolean include_dhcp_address_active ()
    Network_FS_Parameters dhcp_address_name (string name) Network_FS_Parameters dhcp_address_name (string name, boolean include_data) string dhcp_address_name ()
    boolean include_dhcp_address_name () Network_FS_Parameters include_dhcp_address_name (boolean include_data)
    Network_FS_Parameters dhcp_service (string service) Network_FS_Parameters dhcp_service (string service, boolean include_data) string dhcp_service ()
    Network_FS_Parameters include_dhcp_service (boolean include_data) boolean include_dhcp_service ()
    Network_FS_Parameters location (string location) Network_FS_Parameters location (string location, boolean include_data) string location ()
    Network_FS_Parameters include_location (boolean include_data) boolean include_location ()
    Network_FS_Parameters name (string name) Network_FS_Parameters name (string name, boolean include_data) string name ()
    Network_FS_Parameters include_name (boolean include_data) boolean include_name ()
    Network_FS_Parameters network_dhcp_setting (string dhcp_setting) Network_FS_Parameters network_dhcp_setting (string dhcp_setting, boolean include_data) string network_dhcp_setting ()
    Network_FS_Parameters include_network_dhcp_setting (boolean include_data) boolean include_network_dhcp_setting ()
    # The site of Location site-code Network_FS_Parameters site (string site) Network_FS_Parameters site (string site, boolean include_data) string site ()
    Network_FS_Parameters include_site (boolean include_data) boolean include_site ()
    Network_FS_Parameters vlan (string vlan) Network_FS_Parameters vlan (string vlan, boolean include_data) string vlan ()
    Network_FS_Parameters include_vlan (boolean include_data) boolean include_vlan ()
    # Generate a Hashtable with the appropriate values for the legacy Full # Search parser. This method will disappear with legacy Full Search. Hashtable<string,string> legacy_search_params ()
    end
  • Node_FS_Parameters

    class Node_FS_Parameters < Full_Search_Parameters javadoc

    new ()
    Node_FS_Parameters admin_name (string name) Node_FS_Parameters admin_name (string name, boolean include_data) string admin_name ()
    Node_FS_Parameters admin_netid (string netid) Node_FS_Parameters admin_netid (string netid, boolean include_data) string admin_netid ()
    Node_FS_Parameters admin_team (string team_name) Node_FS_Parameters admin_team (string team_name, boolean include_data) string admin_team ()
    Node_FS_Parameters include_administrators (boolean include_data) boolean include_administrators ()
    # The code of Location site-code Node_FS_Parameters code (string code) Node_FS_Parameters code (string code, boolean include_data) string code ()
    Node_FS_Parameters include_code (boolean include_data) boolean include_code ()
    Node_FS_Parameters custom_field (string custom_field) Node_FS_Parameters custom_field (string custom_field, boolean include_data) string custom_field ()
    Node_FS_Parameters include_custom_field (boolean include_data) boolean include_custom_field ()
    Node_FS_Parameters department (string department) Node_FS_Parameters department (string department, boolean include_data) string department ()
    Node_FS_Parameters include_department (boolean include_data) boolean include_department ()
    Node_FS_Parameters dhcp_setting (string dhcp_setting) Node_FS_Parameters dhcp_setting (string dhcp_setting, boolean include_data) string dhcp_setting ()
    Node_FS_Parameters include_dhcp_setting (boolean include_data) boolean include_dhcp_setting ()
    Node_FS_Parameters dhcp (FS_Boolean use_dhcp) Node_FS_Parameters dhcp (FS_Boolean use_dhcp, boolean include_data) FS_Boolean dhcp ()
    Node_FS_Parameters include_dhcp (boolean include_data) boolean include_dhcp ()
    Node_FS_Parameters expires_after_date (string date) Node_FS_Parameters expires_after_date (string date, boolean include_data) string expires_after_date ()
    Node_FS_Parameters expires_before_date (string date) Node_FS_Parameters expires_before_date (string date, boolean include_data) string expires_before_date ()
    Node_FS_Parameters include_expiration_date (boolean include_data) boolean include_expiration_date ()
    Node_FS_Parameters hardware_address (string hardware_address) Node_FS_Parameters hardware_address (string hardware_address, boolean include_data) string hardware_address ()
    Node_FS_Parameters include_hardware_address (boolean include_data) boolean include_hardware_address ()
    Node_FS_Parameters interface_comment (string comment) Node_FS_Parameters interface_comment (string comment, boolean include_data) string interface_comment ()
    Node_FS_Parameters include_interface_comment (boolean include_data) boolean include_interface_comment ()
    Node_FS_Parameters IP_address (string IP_address) Node_FS_Parameters IP_address (string IP_address, boolean include_data) string IP_address ()
    Node_FS_Parameters include_IP_address (boolean include_data) boolean include_IP_address ()
    Node_FS_Parameters IP_active (FS_Boolean active) Node_FS_Parameters IP_active (FS_Boolean active, boolean include_data) FS_Boolean IP_active ()
    Node_FS_Parameters include_IP_active (boolean include_data) boolean include_IP_active ()
    Node_FS_Parameters location (string location) Node_FS_Parameters location (string location, boolean include_data) string location ()
    Node_FS_Parameters include_location (boolean include_data) boolean include_location ()
    Node_FS_Parameters make (string make) Node_FS_Parameters make (string make, boolean include_data) string make ()
    Node_FS_Parameters model (string model) Node_FS_Parameters model (string model, boolean include_data) string model ()
    Node_FS_Parameters include_make_and_model (boolean include_data) boolean include_make_and_model ()
    Node_FS_Parameters name (string name) string name ()
    # It's useful to search on alias on its own. This is necessary and needs to # be implemented when we allow aliases and MXes on IP address and Interface # names, or even sooner. It doesn't depend on allowing those aliases and # MXes so it should be implemented the next time we do significant work # on node full search. Node_FS_Parameters alias (string name) string alias ()
    Node_FS_Parameters include_node_name (boolean include_data) boolean include_node_name ()
    Node_FS_Parameters include_alias (boolean include_data) boolean include_alias ()
    Node_FS_Parameters include_interface_name (boolean include_data) boolean include_interface_name ()
    Node_FS_Parameters include_IP_name (boolean include_data) boolean include_IP_name ()
    Node_FS_Parameters include_ipc_name (boolean include_data) boolean include_ipc_name ()
    Node_FS_Parameters OS (string os) Node_FS_Parameters OS (string os, boolean include_data) string OS ()
    Node_FS_Parameters include_OS (boolean include_data) boolean include_OS ()
    Node_FS_Parameters ptr_pref (FS_Boolean pref) Node_FS_Parameters ptr_pref (FS_Boolean pref, boolean include_data) FS_Boolean ptr_pref ()
    Node_FS_Parameters include_ptr_pref (boolean include_data) boolean include_ptr_pref ()
    Node_FS_Parameters receives_mail_for (string name) Node_FS_Parameters receives_mail_for (string name, boolean include_data) string receives_mail_for ()
    Node_FS_Parameters include_receives_mail_for (boolean include_data) boolean include_receives_mail_for ()
    # Search for nodes in the operating user's groups. If owner() is # also specified the conditions are ORed. Node_FS_Parameters records_in_my_groups (boolean search) boolean records_in_my_groups ()
    Node_FS_Parameters roaming (FS_Boolean roaming) Node_FS_Parameters roaming (FS_Boolean roaming, boolean include_data) FS_Boolean roaming ()
    Node_FS_Parameters include_roaming (boolean include_data) boolean include_roaming ()
    Node_FS_Parameters room (string room) Node_FS_Parameters room (string room, boolean include_data) string room ()
    Node_FS_Parameters include_room (boolean include_data) boolean include_room ()
    Node_FS_Parameters search_node_names (boolean search) boolean search_node_names ()
    # Search for aliases matching the string passed to name(). # Ignored if alias() is not empty. Node_FS_Parameters search_aliases (boolean search) boolean search_aliases ()
    Node_FS_Parameters search_interface_names (boolean search) boolean search_interface_names ()
    Node_FS_Parameters search_IP_names (boolean search) boolean search_IP_names ()
    Node_FS_Parameters search_ipc_names (boolean search) boolean search_ipc_names ()
    # The site of Location site-code Node_FS_Parameters site (string site) Node_FS_Parameters site (string site, boolean include_data) string site ()
    Node_FS_Parameters include_site (boolean include_data) boolean include_site ()
    Node_FS_Parameters state (string state) Node_FS_Parameters state (string state, boolean include_data) string state ()
    Node_FS_Parameters include_state (boolean include_data) boolean include_state ()
    Node_FS_Parameters types (array<Node_Type> types) Node_FS_Parameters types (array<Node_Type> types, boolean include_data) array<Node_Type> types ()
    Node_FS_Parameters not_types (array<Node_Type> types) Node_FS_Parameters not_types (array<Node_Type> types, boolean include_data) array<Node_Type> not_types ()
    Node_FS_Parameters include_types (boolean include_data) boolean include_types ()
    Node_FS_Parameters user_name (string name) Node_FS_Parameters user_name (string name, boolean include_data) string user_name ()
    Node_FS_Parameters user_netid (string netid) Node_FS_Parameters user_netid (string netid, boolean include_data) string user_netid ()
    Node_FS_Parameters include_user (boolean include_data) boolean include_user ()
    # Generate a Hashtable with the appropriate values for the legacy Full # Search parser. This method will disappear with legacy Full Search. Hashtable<string,string> legacy_search_params ()
    end
  • TXT_Record_FS_Parameters

    class TXT_Record_FS_Parameters < Full_Search_Parameters javadoc

    new ()
    TXT_Record_FS_Parameters admin_name (string name) TXT_Record_FS_Parameters admin_name (string name, boolean include_data) string admin_name ()
    TXT_Record_FS_Parameters admin_netid (string netid) TXT_Record_FS_Parameters admin_netid (string netid, boolean include_data) string admin_netid ()
    TXT_Record_FS_Parameters admin_team (string team_name) TXT_Record_FS_Parameters admin_team (string team_name, boolean include_data) string admin_team ()
    TXT_Record_FS_Parameters include_administrators (boolean include_data) boolean include_administrators ()
    TXT_Record_FS_Parameters expires_after_date (string date) TXT_Record_FS_Parameters expires_after_date (string date, boolean include_data) string expires_after_date ()
    TXT_Record_FS_Parameters expires_before_date (string date) TXT_Record_FS_Parameters expires_before_date (string date, boolean include_data) string expires_before_date ()
    TXT_Record_FS_Parameters include_expiration_date (boolean include_data) boolean include_expiration_date ()
    TXT_Record_FS_Parameters name (string name) TXT_Record_FS_Parameters name (string name, boolean include_data) string name ()
    TXT_Record_FS_Parameters include_name (boolean include_data) boolean include_name ()
    TXT_Record_FS_Parameters alias (string name) string alias ()
    TXT_Record_FS_Parameters include_alias (boolean include_data) boolean include_alias ()
    TXT_Record_FS_Parameters search_names (boolean search) boolean search_names ()
    # Search for aliases matching the string passed to alias(), if provided, # otherwise name(). See Adding an alias field to Node Full Search for # implementation details. TXT_Record_FS_Parameters search_aliases (boolean search) boolean search_aliases ()
    TXT_Record_FS_Parameters value (string value) TXT_Record_FS_Parameters value (string value, boolean include_data) string value ()
    TXT_Record_FS_Parameters include_value (boolean include_data) boolean include_value ()
    TXT_Record_FS_Parameters value_admin_name (string name) TXT_Record_FS_Parameters value_admin_name (string name, boolean include_data) string value_admin_name ()
    TXT_Record_FS_Parameters value_admin_netid (string netid) TXT_Record_FS_Parameters value_admin_netid (string netid, boolean include_data) string value_admin_netid ()
    TXT_Record_FS_Parameters value_admin_team (string team_name) TXT_Record_FS_Parameters value_admin_team (string team_name, boolean include_data) string value_admin_team ()
    TXT_Record_FS_Parameters include_value_administrators (boolean include_data) boolean include_value_administrators ()
    TXT_Record_FS_Parameters value_comment (string comment) TXT_Record_FS_Parameters value_comment (string comment, boolean include_data) string value_comment ()
    TXT_Record_FS_Parameters include_value_comment (boolean include_data) boolean include_value_comment ()
    # Generate a Hashtable with the appropriate values for the legacy Full # Search parser. This method will disappear with legacy Full Search. Hashtable<string,string> legacy_search_params ()
    end
  • User_FS_Parameters

    class User_FS_Parameters < Full_Search_Parameters javadoc

    new ()
    User_FS_Parameters active (FS_Boolean active) User_FS_Parameters active (FS_Boolean active, boolean include_data) FS_Boolean active ()
    User_FS_Parameters include_active (boolean include_data) boolean include_active ()
    User_FS_Parameters all_groups (FS_Boolean all_groups) FS_Boolean all_groups ()
    User_FS_Parameters all_records (FS_Boolean all_records) FS_Boolean all_records ()
    User_FS_Parameters consultant_name (string name) User_FS_Parameters consultant_name (string name, boolean include_data) string consultant_name ()
    User_FS_Parameters include_consultant_name (boolean include_data) boolean include_consultant_name ()
    User_FS_Parameters default_domain (string domain) User_FS_Parameters default_domain (string domain, boolean include_data) string default_domain ()
    User_FS_Parameters include_default_domain (boolean include_data) boolean include_default_domain ()
    User_FS_Parameters default_group (string group) User_FS_Parameters default_group (string group, boolean include_data) string default_group ()
    User_FS_Parameters include_default_group (boolean include_data) boolean include_default_group ()
    User_FS_Parameters department (string department) User_FS_Parameters department (string department, boolean include_data) string department ()
    User_FS_Parameters include_department (boolean include_data) boolean include_department ()
    User_FS_Parameters email (string email) User_FS_Parameters email (string email, boolean include_data) string email ()
    User_FS_Parameters include_email (boolean include_data) boolean include_email ()
    User_FS_Parameters last_logged_in_after (string date) User_FS_Parameters last_logged_in_after (string date, boolean include_data) string last_logged_in_after ()
    User_FS_Parameters last_logged_in_before (string date) User_FS_Parameters last_logged_in_before (string date, boolean include_data) string last_logged_in_before ()
    User_FS_Parameters include_last_login (boolean include_data) boolean include_last_login ()
    User_FS_Parameters name (string name) string name ()
    User_FS_Parameters netid (string netid) string netid ()
    User_FS_Parameters phone (string phone) User_FS_Parameters phone (string phone, boolean include_data) string phone ()
    User_FS_Parameters include_phone (boolean include_data) boolean include_phone ()
    User_FS_Parameters privileges (array<Privilege> privileges) User_FS_Parameters privileges (array<Privilege> privileges, boolean include_data) array<Privilege> privileges ()
    User_FS_Parameters include_privileges (boolean include_data) boolean include_privileges ()
    User_FS_Parameters starting_address (string address) User_FS_Parameters starting_address (string address, boolean include_data) string starting_address ()
    User_FS_Parameters include_starting_address (boolean include_data) boolean include_starting_address ()
    # Generate a Hashtable with the appropriate values for the legacy Full # Search parser. This method will disappear with legacy Full Search. Hashtable<string,string> legacy_search_params ()
    end

  • IPaddress

    class IPaddress < IP javadoc

    new (string IP) new (BigInteger IP) new (BigInteger IP, int preferred_format)
    IPaddress next () IPaddress prev ()
    string toString () string toString (int format)
    end

  • Prefix

    class Prefix < IP javadoc

    new (string prefix) new (string IP, int prefix_length)
    IPaddress address() IPaddress broadcast()
    int prefix_length () int prefix_length (int flags)
    BigInteger available_addresses () boolean contains (IPaddress IP) Prefix increase_prefix_size ()
    string toString () string toString (int flags)
    static Prefix join (string new_IP, int new_prefix_length, Prefix[] prefixes) static Prefix join (string new_prefix, Prefix[] prefixes) Prefix[] split ()
    end