How to set custom header in Volley Request

Question

How can custom headers be set for a Volley request  At the moment  there is way to set body content for a POST request  I ve a simple GET request  but I need to pass the custom headers alongwith  I don t see how JsonRequest class supports it  Is it possible at all

User · Answer

If what you need is to post data instead of adding the info in the url.

public Request post(String url, String username, String password, 
      Listener listener, ErrorListener errorListener) {
  JSONObject params = new JSONObject();
  params.put("user", username);
  params.put("pass", password);
  Request req = new Request(
     Method.POST,
     url,
     params.toString(),
     listener,
     errorListener
  );

  return req;
}

If what you want to do is edit the headers in the request this is what you want to do:

// could be any class that implements Map
Map<String, String> mHeaders = new ArrayMap<String, String>();
mHeaders.put("user", USER);
mHeaders.put("pass", PASSWORD);
Request req = new Request(url, postBody, listener, errorListener) {
  public Map<String, String> getHeaders() {
    return mHeaders;
  }
}

User · Answer

As addition I d like to share something I found regarding the Content-Type  On top of    Override public Map lt String  String gt  getHeaders   throws AuthFailureError   Map lt String  String gt  params   new HashMap lt String  String gt           return params      I had to add    Override public String getBodyContentType     return    for exmaple     application json       Don t ask me why  I just thought it might help some others that can t get the Content-Type set right

User · Answer

Looking for solution to this problem as well  see something here  http   developer android com training volley request html  is it a good idea to directly use ImageRequest instead of ImageLoader  Seems ImageLoader uses it internally anyway  Does it miss anything important other than ImageLoader s cache support   ImageView mImageView  String url    http   i imgur com 7spzG png   mImageView    ImageView  findViewById R id myImage           Retrieves an image specified by the URL  displays it in the UI  mRequestQueue   Volley newRequestQueue context    ImageRequest request   new ImageRequest url    new Response Listener            Override       public void onResponse Bitmap bitmap              mImageView setImageBitmap bitmap                0  0  null    new Response ErrorListener           public void onErrorResponse VolleyError error              mImageView setImageResource R drawable image load error                         Override     public Map lt String  String gt  getHeaders   throws AuthFailureError           Map lt String  String gt  params   new Map lt String  String gt             params put  User-Agent    one            params put  header22    two             return params         mRequestQueue add request

User · Answer

try this          Override        public Map lt String  String gt  getHeaders   throws AuthFailureError              String bearer    Bearer   concat token               Map lt String  String gt  headersSys   super getHeaders                Map lt String  String gt  headers   new HashMap lt String  String gt                 headersSys remove  Authorization                headers put  Authorization   bearer               headers putAll headersSys               return headers

User · Answer

That is my code  dont forget   object  if don t put don t works  val queue   Volley newRequestQueue this          val url    http   35 237 133 137 8080 lamarrullaWS rest lamarrullaAPI             Request a string response from the provided URL          val jsonObjectRequest   object  JsonObjectRequest Request Method GET  url  null                  Response Listener   response - gt                      txtPrueba text    Response   s  format response toString                                       Response ErrorListener   txtPrueba text    That didn t work                                      Throws AuthFailureError  class              override fun getHeaders    Map lt String  String gt                    val headers   HashMap lt String  String gt                    headers put  Content-Type    application json                   return headers                                 queue add jsonObjectRequest

User · Answer

You can make a custom Request class that extends the StringRequest and override the getHeaders   method inside it like this    public class CustomVolleyRequest extends StringRequest        public CustomVolleyRequest int method  String url                             Response Listener lt String gt  listener                             Response ErrorListener errorListener            super method  url  listener  errorListener               Override     public Map lt String  String gt  getHeaders   throws AuthFailureError           Map lt String  String gt  headers   new HashMap lt  gt             headers put  key1   value1            headers put  key2   value2            return headers

User · Answer

You can see this solution  It shows how to get set cookies  but cookies are just one of the headers in a request response  You have to override one of the Volley s  Request classes and set the required headers in getHeaders      Here is the linked source   public class StringRequest extends com android volley toolbox StringRequest    private final Map lt String  String gt   params           param method     param url     param params               A   link HashMap  to post with the request  Null is allowed               and indicates no parameters will be posted along with request      param listener     param errorListener     public StringRequest int method  String url  Map lt String  String gt  params  Listener lt String gt  listener          ErrorListener errorListener        super method  url  listener  errorListener         params   params      Override protected Map lt String  String gt  getParams         return  params         non-Javadoc      see com android volley toolbox StringRequest parseNetworkResponse com android volley NetworkResponse       Override protected Response lt String gt  parseNetworkResponse NetworkResponse response           since we don t know which of the two underlying network vehicles        will Volley use  we have to handle and store session cookies manually     MyApp get   checkSessionCookie response headers        return super parseNetworkResponse response          non-Javadoc      see com android volley Request getHeaders        Override public Map lt String  String gt  getHeaders   throws AuthFailureError       Map lt String  String gt  headers   super getHeaders         if  headers    null                headers equals Collections emptyMap               headers   new HashMap lt String  String gt                MyApp get   addSessionCookie headers        return headers         And MyApp class   public class MyApp extends Application       private static final String SET COOKIE KEY    Set-Cookie       private static final String COOKIE KEY    Cookie       private static final String SESSION COOKIE    sessionid        private static MyApp  instance      private RequestQueue  requestQueue      private SharedPreferences  preferences       public static MyApp get             return  instance              Override     public void onCreate             super onCreate             instance   this               preferences   PreferenceManager getDefaultSharedPreferences this            requestQueue   Volley newRequestQueue this              public RequestQueue getRequestQueue             return  requestQueue                         Checks the response headers for session cookie and saves it        if it finds it          param headers Response Headers              public final void checkSessionCookie Map lt String  String gt  headers            if  headers containsKey SET COOKIE KEY                   amp  amp  headers get SET COOKIE KEY  startsWith SESSION COOKIE                     String cookie   headers get SET COOKIE KEY                   if  cookie length    gt  0                        String   splitCookie   cookie split                           String   splitSessionId   splitCookie 0  split                           cookie   splitSessionId 1                       Editor prefEditor    preferences edit                        prefEditor putString SESSION COOKIE  cookie                       prefEditor commit                                                          Adds session cookie to headers if exists          param headers             public final void addSessionCookie Map lt String  String gt  headers            String sessionId    preferences getString SESSION COOKIE               if  sessionId length    gt  0                StringBuilder builder   new StringBuilder                builder append SESSION COOKIE               builder append                   builder append sessionId               if  headers containsKey COOKIE KEY                     builder append                        builder append headers get COOKIE KEY                              headers put COOKIE KEY  builder toString

User · Answer

The accepted answer with getParams   is for setting POST body data  but the question in the title asked how to set HTTP headers like User-Agent  As CommonsWare said  you override getHeaders    Here s some sample code which sets the User-Agent to  Nintendo Gameboy  and Accept-Language to  fr    public void requestWithSomeHttpHeaders         RequestQueue queue   Volley newRequestQueue this       String url    http   www somewebsite com       StringRequest getRequest   new StringRequest Request Method GET  url           new Response Listener lt String gt                            Override             public void onResponse String response                       response                 Log d  Response   response                                     new Response ErrorListener                           Override             public void onErrorResponse VolleyError error                       TODO Auto-generated method stub                 Log d  ERROR   error   gt    error toString                                                   Override         public Map lt String  String gt  getHeaders   throws AuthFailureError                    Map lt String  String gt   params   new HashMap lt String  String gt                       params put  User-Agent    Nintendo Gameboy                      params put  Accept-Language    fr                     return params                         queue add getRequest

User · Answer

public class CustomJsonObjectRequest  extends JsonObjectRequest       public CustomJsonObjectRequest int method  String url  JSONObject jsonRequest Response Listener listener  Response ErrorListener errorListener                super method  url  jsonRequest  listener  errorListener            Override public Map getHeaders   throws AuthFailureError       Map headers   new HashMap        headers put  AppId    xyz         return headers

User · Answer

Here is setting headers from github sample   StringRequest myReq   new StringRequest Method POST                          http   ave bolyartech com params php                           createMyReqSuccessListener                            createMyReqErrorListener        protected Map lt String  String gt  getParams   throws           com android volley AuthFailureError                           Map lt String  String gt  params   new HashMap lt String  String gt                             params put  param1   num1                           params put  param2   num2                           return params                                                            queue add myReq

User · Answer

try this   public void VolleyPostReqWithResponseListenerwithHeaders String URL final Map lt String  String gt  params final Map lt String  String gt  headers Response Listener lt String gt  responseListener          String url   URL       Log i  url          url       StringRequest mStringRequest   new StringRequest Request Method POST              url  responseListener  new Response ErrorListener              Override         public void onErrorResponse VolleyError error                   error                 Log d  Error Response   error getLocalizedMessage                                Override         protected Map lt String  String gt  getParams                 return params                      Override         public Map lt String  String gt  getHeaders   throws AuthFailureError               return headers                          mStringRequest setRetryPolicy new DefaultRetryPolicy              60000              DefaultRetryPolicy DEFAULT MAX RETRIES              DefaultRetryPolicy DEFAULT BACKOFF MULT         mStringRequest setShouldCache true              dialog show        SingletonRequestQueue getInstance context  addToRequestQueue mStringRequest

User · Answer

It looks like you override public Map lt String  String gt  getHeaders    defined in Request  to return your desired HTTP headers

User · Answer

In Kotlin   You have to override getHeaders   method like     val volleyEnrollRequest   object   JsonObjectRequest GET POST PARAM  TARGET URL  PAYLOAD BODY IF YOU WISH              Response Listener                      Success Part                               Response ErrorListener                      Failure Part                                          Providing Request Headers              override fun getHeaders    Map lt String  String gt                      Create HashMap of your Headers as the example provided below                  val headers   HashMap lt String  String gt                    headers  Content-Type      application json                  headers  app id     APP ID                 headers  app key     API KEY                  return headers

[android] How to set custom header in Volley Request

Examples related to android

Examples related to android-volley