Class Context

  • All Implemented Interfaces:
    com.anaptecs.jeaf.core.api.ServiceObject, java.io.Serializable
    Direct Known Subclasses:
    SpecialContext

    @Valid
    public class Context
    extends java.lang.Object
    implements com.anaptecs.jeaf.core.api.ServiceObject
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Context.Builder
      Class implements builder to create a new instance of class Context.
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected Context()
      Default constructor is only intended to be used for deserialization by tools like Jackson for JSON.
      protected Context​(Context.Builder pBuilder)
      Initialize object using the passed builder.
    • Constructor Detail

      • Context

        protected Context()
        Default constructor is only intended to be used for deserialization by tools like Jackson for JSON. For "normal" object creation builder should be used instead.
      • Context

        protected Context​(Context.Builder pBuilder)
        Initialize object using the passed builder.
        Parameters:
        pBuilder - Builder that should be used to initialize this object. The parameter must not be null.
    • Method Detail

      • builder

        public static Context.Builder builder()
        Method returns a new builder.
        Returns:
        Context.Builder New builder that can be used to create new Context objects.
      • builder

        public static Context.Builder builder​(Context pObject)
        Method creates a new builder and initialize it with the data from the passed object.
        Parameters:
        pObject - Object that should be used to initialize the builder. The parameter may be null.
        Returns:
        Context.Builder New builder that can be used to create new Context objects. The method never returns null.
      • builder

        public static Context.Builder builder​(java.lang.String pAccessToken,
                                              java.util.Locale pLanguage,
                                              long pResellerID,
                                              long pPathParam,
                                              java.lang.String pQueryParam)
        Method creates a new builder and initializes it with the passed attributes.
      • getAccessToken

        public java.lang.String getAccessToken()
        Method returns attribute accessToken.
        Returns:
        String Value to which accessToken is set.
      • setAccessToken

        public void setAccessToken​(java.lang.String pAccessToken)
        Method sets attribute accessToken.
        Parameters:
        pAccessToken - Value to which accessToken should be set.
      • getLanguage

        public java.util.Locale getLanguage()
        Method returns attribute language.
        Returns:
        Locale Value to which language is set.
      • setLanguage

        public void setLanguage​(java.util.Locale pLanguage)
        Method sets attribute language.
        Parameters:
        pLanguage - Value to which language should be set.
      • getResellerID

        public long getResellerID()
        Method returns attribute resellerID.
        Returns:
        long Value to which resellerID is set.
      • setResellerID

        public void setResellerID​(long pResellerID)
        Method sets attribute resellerID.
        Parameters:
        pResellerID - Value to which resellerID should be set.
      • getPathParam

        public long getPathParam()
        Method returns attribute pathParam.
        Returns:
        long Value to which pathParam is set.
      • setPathParam

        public void setPathParam​(long pPathParam)
        Method sets attribute pathParam.
        Parameters:
        pPathParam - Value to which pathParam should be set.
      • getQueryParam

        public java.lang.String getQueryParam()
        Method returns attribute queryParam.
        Returns:
        String Value to which queryParam is set.
      • setQueryParam

        public void setQueryParam​(java.lang.String pQueryParam)
        Method sets attribute queryParam.
        Parameters:
        pQueryParam - Value to which queryParam should be set.
      • getCustomHeaders

        public java.util.Map<java.lang.String,​java.lang.String> getCustomHeaders()
        Method returns map with all custom headers that were added
        Returns:
        Map Map with all custom headers. The method never returns null. The returned map is unmodifiable.
      • addCustomHeader

        public void addCustomHeader​(java.lang.String pHeaderName,
                                    java.lang.String pHeaderValue)
        Method adds the passed values as custom headers. The passed name and value of the http header must be compliant with guidelines about http headers.
        Parameters:
        pHeaderName - Name of the HTTP header. The parameter must not be null,
        pHeaderValue - Value of the http header the parameter may be null.
      • toStringBuilder

        public java.lang.StringBuilder toStringBuilder​(java.lang.String pIndent)
        Method returns a StringBuilder that can be used to create a String representation of this object. The returned StringBuilder also takes care about attributes of super classes.
        Returns:
        StringBuilder StringBuilder representing this object. The method never returns null.
      • toString

        public java.lang.String toString()
        Method creates a new String with the values of all attributes of this class. All references to other objects will be ignored.
        Overrides:
        toString in class java.lang.Object
        Returns:
        String String representation of this object. The method never returns null.