javax.print.attribute.standard

Class RequestingUserName

Contents
  • All Implemented Interfaces:
    Serializable, Cloneable, Attribute, PrintRequestAttribute

    public final class RequestingUserName
extends TextSyntax
implements PrintRequestAttribute
    Class RequestingUserName is a printing attribute class, a text attribute, that specifies the name of the end user that submitted the print job. A requesting user name is an arbitrary string defined by the client. The printer does not put the client-specified RequestingUserName attribute into the Print Job's attribute set; rather, the printer puts in a JobOriginatingUserName attribute. This means that services which support specifying a username with this attribute should also report a JobOriginatingUserName in the job's attribute set. Note that many print services may have a way to independently authenticate the user name, and so may state support for a requesting user name, but in practice will then report the user name authenticated by the service rather than that specified via this attribute.

    IPP Compatibility: The string value gives the IPP name value. The locale gives the IPP natural language. The category name returned by getName() gives the IPP attribute name.

    See Also:
    Serialized Form

    • Constructor Detail

      • RequestingUserName

        public RequestingUserName(String userName,
                  Locale locale)
        Constructs a new requesting user name attribute with the given user name and locale.
        Parameters:
        userName - User name.
        locale - Natural language of the text string. null is interpreted to mean the default locale as returned by Locale.getDefault()
        Throws:
        NullPointerException - (unchecked exception) Thrown if userName is null.

    • Method Detail

      • equals

        public boolean equals(Object object)
        Returns whether this requesting user name attribute is equivalent to the passed in object. To be equivalent, all of the following conditions must be true:
        1. object is not null.
        2. object is an instance of class RequestingUserName.
        3. This requesting user name attribute's underlying string and object's underlying string are equal.
        4. This requesting user name attribute's locale and object's locale are equal.
        Overrides:
        equals in class TextSyntax
        Parameters:
        object - Object to compare to.
        Returns:
        True if object is equivalent to this requesting user name attribute, false otherwise.
        See Also:
        Object.hashCode(), HashMap

      • getCategory

        public final Class<? extends Attribute> getCategory()
        Get the printing attribute class which is to be used as the "category" for this printing attribute value.

        For class RequestingUserName, the category is class RequestingUserName itself.

        Specified by:
        getCategory in interface Attribute
        Returns:
        Printing attribute class (category), an instance of class java.lang.Class.

      • getName

        public final String getName()
        Get the name of the category of which this attribute value is an instance.

        For class RequestingUserName, the category name is "requesting-user-name".

        Specified by:
        getName in interface Attribute
        Returns:
        Attribute category name.

Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/print/attribute/standard/requestingusername.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut