User::Identity::System(3pm)

1User::Identity::System(U3s)er Contributed Perl DocumentatUisoenr::Identity::System(3)
2
3
4

NAME

6       User::Identity::System - physical system of a person
7

INHERITANCE

9        User::Identity::System
10          is a User::Identity::Item
11

SYNOPSIS

13        use User::Identity;
14        use User::Identity::System;
15        my $me   = User::Identity->new(...);
16        my $server = User::Identity::System->new(...);
17        $me->add(system => $server);
18
19        # Simpler
20
21        use User::Identity;
22        my $me   = User::Identity->new(...);
23        my $addr = $me->add(system => ...);
24

DESCRIPTION

26       The "User::Identity::System" object contains the description of the
27       user's presence on a system.  The systems are collected by an
28       User::Identity::Collection::Systems object.
29
30       Nearly all methods can return undef.
31
32       Extends "DESCRIPTION" in User::Identity::Item.
33

METHODS

35       Extends "METHODS" in User::Identity::Item.
36
37   Constructors
38       Extends "Constructors" in User::Identity::Item.
39
40       User::Identity::System->new( [$name], %options )
41           Create a new system.  You can specify a name as first argument, or
42           in the OPTION list.  Without a specific name, the organization is
43           used as name.
44
45            -Option     --Defined in          --Default
46             description  User::Identity::Item  undef
47             hostname                           'localhost'
48             location                           undef
49             name         User::Identity::Item  <required>
50             os                                 undef
51             parent       User::Identity::Item  undef
52             password                           undef
53             username                           undef
54
55           description => STRING
56           hostname => DOMAIN
57             The hostname of the described system.  It is preferred to use
58             full system names, not abbreviations.  For instance, you can
59             better use "www.tux.aq" than "www" to avoid confusion.
60
61           location => NICKNAME|OBJECT
62             The NICKNAME of a location which is defined for the same user.
63             You can also specify a User::Identity::Location OBJECT.
64
65           name => STRING
66           os => STRING
67             The name of the operating system which is run on the server.  It
68             is advised to use the names as used by Perl's $^O variable.  See
69             the perlvar man-page for this variable, and perlport for the
70             possible values.
71
72           parent => OBJECT
73           password => STRING
74             The password to be used to login.  This password must be un-
75             encoded: directly usable.  Be warned that storing un-encoded
76             passwords is a high security list.
77
78           username => STRING
79             The username to be used to login to this host.
80
81   Attributes
82       Extends "Attributes" in User::Identity::Item.
83
84       $obj->description()
85           Inherited, see "Attributes" in User::Identity::Item
86
87       $obj->hostname()
88       $obj->location()
89           Returns the object which describes to which location this system
90           relates.  The location may be used to find the name of the
91           organization involved, or to create a signature.  If no location is
92           specified, undef is returned.
93
94       $obj->name( [$newname] )
95           Inherited, see "Attributes" in User::Identity::Item
96
97       $obj->os()
98       $obj->password()
99       $obj->username()
100
101   Collections
102       Extends "Collections" in User::Identity::Item.
103
104       $obj->add($collection, $role)
105           Inherited, see "Collections" in User::Identity::Item
106
107       $obj->addCollection( $object | <[$type], %options> )
108           Inherited, see "Collections" in User::Identity::Item
109
110       $obj->collection($name)
111           Inherited, see "Collections" in User::Identity::Item
112
113       $obj->parent( [$parent] )
114           Inherited, see "Collections" in User::Identity::Item
115
116       $obj->removeCollection($object|$name)
117           Inherited, see "Collections" in User::Identity::Item
118
119       $obj->type()
120       User::Identity::System->type()
121           Inherited, see "Collections" in User::Identity::Item
122
123       $obj->user()
124           Inherited, see "Collections" in User::Identity::Item
125
126   Searching
127       Extends "Searching" in User::Identity::Item.
128
129       $obj->find($collection, $role)
130           Inherited, see "Searching" in User::Identity::Item
131

DIAGNOSTICS

133       Error: $object is not a collection.
134           The first argument is an object, but not of a class which extends
135           User::Identity::Collection.
136
137       Error: Cannot load collection module for $type ($class).
138           Either the specified $type does not exist, or that module named
139           $class returns compilation errors.  If the type as specified in the
140           warning is not the name of a package, you specified a nickname
141           which was not defined.  Maybe you forgot the 'require' the package
142           which defines the nickname.
143
144       Error: Creation of a collection via $class failed.
145           The $class did compile, but it was not possible to create an object
146           of that class using the options you specified.
147
148       Error: Don't know what type of collection you want to add.
149           If you add a collection, it must either by a collection object or a
150           list of options which can be used to create a collection object.
151           In the latter case, the type of collection must be specified.
152
153       Warning: No collection $name
154           The collection with $name does not exist and can not be created.
155

LICENSE

161       Copyrights 2003-2023 by [Mark Overmeer <markov@cpan.org>]. For other
162       contributors see ChangeLog.
163
164       This program is free software; you can redistribute it and/or modify it
165       under the same terms as Perl itself.  See http://dev.perl.org/licenses/
166
167
168
169perl v5.36.1                      2023-04-30         User::Identity::System(3)