Package apple.foundation

Class NSHTTPCookie

  • All Implemented Interfaces:
    NSObject
    public class NSHTTPCookie
extends NSObject
    NSHTTPCookie NSHTTPCookie represents an http cookie. A NSHTTPCookie instance represents a single http cookie. It is an immutable object initialized from a dictionary that contains the various cookie attributes. It has accessors to get the various attributes of a cookie.

    • Constructor Detail

      • NSHTTPCookie

        protected NSHTTPCookie​(org.moe.natj.general.Pointer peer)

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

        public static java.lang.Object allocWithZone​(org.moe.natj.general.ptr.VoidPtr zone)

      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(java.lang.String key)

      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(java.lang.Object aTarget)

      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(java.lang.Object aTarget,
                                                                         org.moe.natj.objc.SEL aSelector,
                                                                         java.lang.Object anArgument)

      • classFallbacksForKeyedArchiver

        public static NSArray<java.lang.String> classFallbacksForKeyedArchiver()

      • classForKeyedUnarchiver

        public static org.moe.natj.objc.Class classForKeyedUnarchiver()

      • cookieWithProperties

        public static NSHTTPCookie cookieWithProperties​(NSDictionary<java.lang.String,​?> properties)
        cookieWithProperties: Allocates and initializes an NSHTTPCookie with the given dictionary. See the NSHTTPCookie -initWithProperties: method for more information on the constraints imposed on the dictionary, and for descriptions of the supported keys and values.
        Parameters:
        properties - The dictionary to use to initialize this cookie.
        Returns:
        A newly-created and autoreleased NSHTTPCookie instance, or nil if the set of dictionary keys is invalid, for example because a required key is missing, or a recognized key maps to an illegal value.

      • cookiesWithResponseHeaderFieldsForURL

        public static NSArray<? extends NSHTTPCookie> cookiesWithResponseHeaderFieldsForURL​(NSDictionary<java.lang.String,​java.lang.String> headerFields,
                                                                                    NSURL URL)
        cookiesWithResponseHeaderFields:forURL: Return an array of cookies parsed from the specified response header fields and URL. This method will ignore irrelevant header fields so you can pass a dictionary containing data other than cookie data.
        Parameters:
        headerFields - The response header fields to check for cookies.
        URL - The URL that the cookies came from - relevant to how the cookies are interpeted.
        Returns:
        An NSArray of NSHTTPCookie objects

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • description_static

        public static java.lang.String description_static()

      • hash_static

        public static long hash_static()

      • instanceMethodSignatureForSelector

        public static NSMethodSignature instanceMethodSignatureForSelector​(org.moe.natj.objc.SEL aSelector)

      • instancesRespondToSelector

        public static boolean instancesRespondToSelector​(org.moe.natj.objc.SEL aSelector)

      • isSubclassOfClass

        public static boolean isSubclassOfClass​(org.moe.natj.objc.Class aClass)

      • keyPathsForValuesAffectingValueForKey

        public static NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey​(java.lang.String key)

      • new_objc

        public static java.lang.Object new_objc()

      • requestHeaderFieldsWithCookies

        public static NSDictionary<java.lang.String,​java.lang.String> requestHeaderFieldsWithCookies​(NSArray<? extends NSHTTPCookie> cookies)
        requestHeaderFieldsWithCookies: Return a dictionary of header fields that can be used to add the specified cookies to the request.
        Parameters:
        cookies - The cookies to turn into request headers.
        Returns:
        An NSDictionary where the keys are header field names, and the values are the corresponding header field values.

      • resolveClassMethod

        public static boolean resolveClassMethod​(org.moe.natj.objc.SEL sel)

      • resolveInstanceMethod

        public static boolean resolveInstanceMethod​(org.moe.natj.objc.SEL sel)

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • superclass_static

        public static org.moe.natj.objc.Class superclass_static()

      • comment

        public java.lang.String comment()
        Returns the comment of the receiver. This value specifies a string which is suitable for presentation to the user explaining the contents and purpose of this cookie. It may be nil.
        Returns:
        The comment of the receiver, or nil if the receiver has no comment.

      • commentURL

        public NSURL commentURL()
        Returns the comment URL of the receiver. This value specifies a URL which is suitable for presentation to the user as a link for further information about this cookie. It may be nil.
        Returns:
        The comment URL of the receiver, or nil if the receiver has no comment URL.

      • domain

        public java.lang.String domain()
        Returns the domain of the receiver. This value specifies URL domain to which the cookie should be sent. A domain with a leading dot means the cookie should be sent to subdomains as well, assuming certain other restrictions are valid. See RFC 2965 for more detail.
        Returns:
        The domain of the receiver.

      • expiresDate

        public NSDate expiresDate()
        Returns the expires date of the receiver. The expires date is the date when the cookie should be deleted. The result will be nil if there is no specific expires date. This will be the case only for "session-only" cookies.
        Returns:
        the expires date of the receiver.

      • initWithProperties

        public NSHTTPCookie initWithProperties​(NSDictionary<java.lang.String,​?> properties)
        initWithProperties: Initialize a NSHTTPCookie object with a dictionary of parameters Supported dictionary keys and value types for the given dictionary are as follows. All properties can handle an NSString value, but some can also handle other types.
        Property key constant Type of value Required Description
        NSHTTPCookieComment NSString NO Comment for the cookie. Only valid for version 1 cookies and later. Default is nil.
        NSHTTPCookieCommentURL NSURL or NSString NO Comment URL for the cookie. Only valid for version 1 cookies and later. Default is nil.
        NSHTTPCookieDomain NSString Special, a value for either NSHTTPCookieOriginURL or NSHTTPCookieDomain must be specified. Domain for the cookie. Inferred from the value for NSHTTPCookieOriginURL if not provided.
        NSHTTPCookieDiscard NSString NO A string stating whether the cookie should be discarded at the end of the session. String value must be either "TRUE" or "FALSE". Default is "FALSE", unless this is cookie is version 1 or greater and a value for NSHTTPCookieMaximumAge is not specified, in which case it is assumed "TRUE".
        NSHTTPCookieExpires NSDate or NSString NO Expiration date for the cookie. Used only for version 0 cookies. Ignored for version 1 or greater.
        NSHTTPCookieMaximumAge NSString NO A string containing an integer value stating how long in seconds the cookie should be kept, at most. Only valid for version 1 cookies and later. Default is "0".
        NSHTTPCookieName NSString YES Name of the cookie
        NSHTTPCookieOriginURL NSURL or NSString Special, a value for either NSHTTPCookieOriginURL or NSHTTPCookieDomain must be specified. URL that set this cookie. Used as default for other fields as noted.
        NSHTTPCookiePath NSString NO Path for the cookie. Inferred from the value for NSHTTPCookieOriginURL if not provided. Default is "/".
        NSHTTPCookiePort NSString NO comma-separated integer values specifying the ports for the cookie. Only valid for version 1 cookies and later. Default is empty string ("").
        NSHTTPCookieSecure NSString NO A string stating whether the cookie should be transmitted only over secure channels. String value must be either "TRUE" or "FALSE". Default is "FALSE".
        NSHTTPCookieValue NSString YES Value of the cookie
        NSHTTPCookieVersion NSString NO Specifies the version of the cookie. Must be either "0" or "1". Default is "0".

        All other keys are ignored.

        Parameters:
        properties - The dictionary of properties to be used to initialize this cookie.
        Returns:
        An initialized NSHTTPCookie, or nil if the set of dictionary keys is invalid, for example because a required key is missing, or a recognized key maps to an illegal value.

      • isHTTPOnly

        public boolean isHTTPOnly()
        Returns whether the receiver should only be sent to HTTP servers per RFC 2965 Cookies may be marked as HTTPOnly by a server (or by a javascript). Cookies marked as such must only be sent via HTTP Headers in HTTP Requests for URL's that match both the path and domain of the respective Cookies. Specifically these cookies should not be delivered to any javascript applications to prevent cross-site scripting vulnerabilities.
        Returns:
        YES if this cookie should only be sent via HTTP headers, NO otherwise.

      • isSecure

        public boolean isSecure()
        Returns whether the receiver should be sent only over secure channels Cookies may be marked secure by a server (or by a javascript). Cookies marked as such must only be sent via an encrypted connection to trusted servers (i.e. via SSL or TLS), and should not be delievered to any javascript applications to prevent cross-site scripting vulnerabilities.
        Returns:
        YES if this cookie should be sent only over secure channels, NO otherwise.

      • isSessionOnly

        public boolean isSessionOnly()
        Returns whether the receiver is session-only.
        Returns:
        YES if this receiver should be discarded at the end of the session (regardless of expiration date), NO if receiver need not be discarded at the end of the session.

      • name

        public java.lang.String name()
        Returns the name of the receiver.
        Returns:
        the name of the receiver.

      • path

        public java.lang.String path()
        Returns the path of the receiver. This value specifies the URL path under the cookie's domain for which this cookie should be sent. The cookie will also be sent for children of that path, so "/" is the most general.
        Returns:
        The path of the receiver.

      • portList

        public NSArray<? extends NSNumber> portList()
        Returns the list ports to which the receiver should be sent. This value specifies an NSArray of NSNumbers (containing integers) which specify the only ports to which this cookie should be sent.
        Returns:
        The list ports to which the receiver should be sent. The array may be nil, in which case this cookie can be sent to any port.

      • properties

        public NSDictionary<java.lang.String,​?> properties()
        Returns a dictionary representation of the receiver. This method returns a dictionary representation of the NSHTTPCookie which can be saved and passed to -initWithProperties: or +cookieWithProperties: later to reconstitute an equivalent cookie.

        See the NSHTTPCookie -initWithProperties: method for more information on the constraints imposed on the dictionary, and for descriptions of the supported keys and values.

        Returns:
        The dictionary representation of the receiver.

      • value

        public java.lang.String value()
        Returns the value of the receiver.
        Returns:
        the value of the receiver.

      • version

        public long version()
        Returns the version of the receiver. Version 0 maps to "old-style" Netscape cookies. Version 1 maps to RFC2965 cookies. There may be future versions.
        Returns:
        the version of the receiver.

      • sameSitePolicy

        public java.lang.String sameSitePolicy()
        Returns the value of the same site attribute on the cookie. Cookies can be marked with an attribute Strict or Lax. Cookies marked with "strict" (NSHTTPCookieSameSiteStrict) are not sent along with cross-site requests. Cookies marked with "lax" (NSHTTPCookieSameSiteLax) sent along cross-site requests provided the cross-site requests are top-level-requests (one that changes the url in the address bar). The attribute value is canonicalized and stored. Any value other than the default (strict and lax) will be ignored.
        Returns:
        strict or lax. The result could also be nil, in which case the cookie will be sent along with all cross-site requests.