src/share/classes/javax/print/attribute/standard/JobOriginatingUserName.java

Print this page




  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      */




  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      */