1 /*
2 * Copyright (c) 2000, 2004, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
30 import javax.print.attribute.TextSyntax;
31 import javax.print.attribute.PrintJobAttribute;
32
33 /**
34 * Class JobOriginatingUserName is a printing attribute class, a text
35 * attribute, that contains the name of the end user that submitted the
36 * print job. If possible, the printer sets this attribute to the most
37 * authenticated printable user name that it can obtain from the
38 * authentication service that authenticated the submitted Print Request.
39 * If such is not available, the printer uses the value of the
40 * {@link RequestingUserName RequestingUserName}
41 * attribute supplied by the client in the Print Request's attribute set.
42 * If no authentication service is available, and the client did not supply
43 * a {@link RequestingUserName RequestingUserName} attribute,
44 * the printer sets the JobOriginatingUserName attribute to an empty
45 * (zero-length) string.
46 * <P>
47 * <B>IPP Compatibility:</B> The string value gives the IPP name value. The
48 * locale gives the IPP natural language. The category name returned by
49 * <CODE>getName()</CODE> gives the IPP attribute name.
50 * <P>
51 *
52 * @author Alan Kaminsky
53 */
54 public final class JobOriginatingUserName extends TextSyntax
55 implements PrintJobAttribute {
56
57 private static final long serialVersionUID = -8052537926362933477L;
58
59 /**
60 * Constructs a new job originating user name attribute with the given
61 * user name and locale.
62 *
63 * @param userName User name.
64 * @param locale Natural language of the text string. null
65 * is interpreted to mean the default locale as returned
66 * by <code>Locale.getDefault()</code>
67 *
68 * @exception NullPointerException
69 * (unchecked exception) Thrown if <CODE>userName</CODE> is null.
70 */
|
1 /*
2 * Copyright (c) 2000, 2014, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
30 import javax.print.attribute.TextSyntax;
31 import javax.print.attribute.PrintJobAttribute;
32
33 /**
34 * Class JobOriginatingUserName is a printing attribute class, a text
35 * attribute, that contains the name of the end user that submitted the
36 * print job. If possible, the printer sets this attribute to the most
37 * authenticated printable user name that it can obtain from the
38 * authentication service that authenticated the submitted Print Request.
39 * If such is not available, the printer uses the value of the
40 * {@link RequestingUserName RequestingUserName}
41 * attribute supplied by the client in the Print Request's attribute set.
42 * If no authentication service is available, and the client did not supply
43 * a {@link RequestingUserName RequestingUserName} attribute,
44 * the printer sets the JobOriginatingUserName attribute to an empty
45 * (zero-length) string.
46 * <P>
47 * <B>IPP Compatibility:</B> The string value gives the IPP name value. The
48 * locale gives the IPP natural language. The category name returned by
49 * <CODE>getName()</CODE> gives the IPP attribute name.
50 *
51 * @author Alan Kaminsky
52 */
53 public final class JobOriginatingUserName extends TextSyntax
54 implements PrintJobAttribute {
55
56 private static final long serialVersionUID = -8052537926362933477L;
57
58 /**
59 * Constructs a new job originating user name attribute with the given
60 * user name and locale.
61 *
62 * @param userName User name.
63 * @param locale Natural language of the text string. null
64 * is interpreted to mean the default locale as returned
65 * by <code>Locale.getDefault()</code>
66 *
67 * @exception NullPointerException
68 * (unchecked exception) Thrown if <CODE>userName</CODE> is null.
69 */
|