1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
=encoding utf8
=head1 NAME
User::Identity::System - physical system of a person
=head1 INHERITANCE
User::Identity::System
is a User::Identity::Item
=head1 SYNOPSIS
use User::Identity;
use User::Identity::System;
my $me = User::Identity->new(...);
my $server = User::Identity::System->new(...);
$me->add(system => $server);
# Simpler
use User::Identity;
my $me = User::Identity->new(...);
my $addr = $me->add(system => ...);
=head1 DESCRIPTION
The C<User::Identity::System> object contains the description of the
user's presence on a system. The systems are collected
by an L<User::Identity::Collection::Systems|User::Identity::Collection::Systems> object.
Nearly all methods can return C<undef>.
Extends L<"DESCRIPTION" in User::Identity::Item|User::Identity::Item/"DESCRIPTION">.
=head1 METHODS
Extends L<"METHODS" in User::Identity::Item|User::Identity::Item/"METHODS">.
=head2 Constructors
Extends L<"Constructors" in User::Identity::Item|User::Identity::Item/"Constructors">.
=over 4
=item $class-E<gt>B<new>( [$name], %options )
Create a new system. You can specify a name as first argument, or
in the OPTION list. Without a specific name, the organization is used as name.
-Option --Defined in --Default
description User::Identity::Item undef
hostname 'localhost'
location undef
name User::Identity::Item <required>
os undef
parent User::Identity::Item undef
password undef
username undef
=over 2
=item description => STRING
=item hostname => $name
The C<$name> of the described system. It is preferred to use full
system names, not abbreviations. For instance, you can better use
C<www.tux.aq> than C<www> to avoid confusion.
=item location => $nick|OBJECT
The C<$nick> of a location which is defined for the same user. You can
also specify a L<User::Identity::Location|User::Identity::Location> OBJECT.
=item name => STRING
=item os => STRING
The name of the operating system which is run on the server. It is
advised to use the names as used by Perl's C<$^O> variable. See the
perlvar man-page for this variable, and perlport for the possible
values.
=item parent => OBJECT
=item password => STRING
The password to be used to login. This password must be un-encoded:
directly usable. Be warned that storing un-encoded passwords is a
high security list.
=item username => STRING
The username to be used to login to this host.
=back
=back
=head2 Attributes
Extends L<"Attributes" in User::Identity::Item|User::Identity::Item/"Attributes">.
=over 4
=item $obj-E<gt>B<description>()
Inherited, see L<User::Identity::Item/"Attributes">
=item $obj-E<gt>B<hostname>()
Z<>
=item $obj-E<gt>B<location>()
Returns the object which describes to which location this system relates.
The location may be used to find the name of the organization involved, or
to create a signature. If no location is specified, C<undef> is returned.
=item $obj-E<gt>B<name>( [$newname] )
Inherited, see L<User::Identity::Item/"Attributes">
=item $obj-E<gt>B<os>()
Z<>
=item $obj-E<gt>B<password>()
Z<>
=item $obj-E<gt>B<username>()
Z<>
=back
=head2 Collections
Extends L<"Collections" in User::Identity::Item|User::Identity::Item/"Collections">.
=over 4
=item $obj-E<gt>B<add>($collection, $role)
Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<addCollection>( $object | <[$type], %options> )
Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<collection>($name)
Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<parent>( [$parent] )
Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<removeCollection>($object|$name)
Inherited, see L<User::Identity::Item/"Collections">
=item $any-E<gt>B<type>()
Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<user>()
Inherited, see L<User::Identity::Item/"Collections">
=back
=head2 Searching
Extends L<"Searching" in User::Identity::Item|User::Identity::Item/"Searching">.
=over 4
=item $obj-E<gt>B<find>($collection, $role)
Inherited, see L<User::Identity::Item/"Searching">
=back
=head1 DIAGNOSTICS
=over 4
=item Error: cannot load collection module for $type ($class): $@
Either the specified C<$type> does not exist, or that module named C<$class> returns
compilation errors. If the type as specified in the warning is not
the name of a package, you specified a nickname which was not defined.
Maybe you forgot the 'require' the package which defines the nickname.
Cast by C<addCollection()>
=item Error: nvalid collection $name.
The collection with C<$name> does not exist and can not be created.
Cast by C<add()>
=item Error: this $object is not a collection.
Cast by C<addCollection()>
=back
=head1 SEE ALSO
This module is part of User-Identity version 4.00,
built on December 12, 2025. Website: F<http://perl.overmeer.net/CPAN/>
=head1 LICENSE
For contributors see file ChangeLog.
This software is copyright (c) 2003-2025 by Mark Overmeer.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
|
