com.google.api.services.analytics.AnalyticsRequestInitializer Maven / Gradle / Ivy
/*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
/*
* This code was generated by https://github.com/googleapis/google-api-java-client-services/
* Modify at your own risk.
*/
package com.google.api.services.analytics;
/**
* Analytics request initializer for setting properties like key and userIp.
*
*
* The simplest usage is to use it to set the key parameter:
*
*
*
public static final GoogleClientRequestInitializer KEY_INITIALIZER =
new AnalyticsRequestInitializer(KEY);
*
*
*
* There is also a constructor to set both the key and userIp parameters:
*
*
*
public static final GoogleClientRequestInitializer INITIALIZER =
new AnalyticsRequestInitializer(KEY, USER_IP);
*
*
*
* If you want to implement custom logic, extend it like this:
*
*
*
public static class MyRequestInitializer extends AnalyticsRequestInitializer {
{@literal @}Override
public void initializeAnalyticsRequest(AnalyticsRequest{@literal <}?{@literal >} request)
throws IOException {
// custom logic
}
}
*
*
*
* Finally, to set the key and userIp parameters and insert custom logic, extend it like this:
*
*
*
public static class MyRequestInitializer2 extends AnalyticsRequestInitializer {
public MyKeyRequestInitializer() {
super(KEY, USER_IP);
}
{@literal @}Override
public void initializeAnalyticsRequest(AnalyticsRequest{@literal <}?{@literal >} request)
throws IOException {
// custom logic
}
}
*
*
*
* Subclasses should be thread-safe.
*
*
* @since 1.12
*/
public class AnalyticsRequestInitializer extends com.google.api.client.googleapis.services.json.CommonGoogleJsonClientRequestInitializer {
public AnalyticsRequestInitializer() {
super();
}
/**
* @param key API key or {@code null} to leave it unchanged
*/
public AnalyticsRequestInitializer(String key) {
super(key);
}
/**
* @param key API key or {@code null} to leave it unchanged
* @param userIp user IP or {@code null} to leave it unchanged
*/
public AnalyticsRequestInitializer(String key, String userIp) {
super(key, userIp);
}
@Override
public final void initializeJsonRequest(com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest request) throws java.io.IOException {
super.initializeJsonRequest(request);
initializeAnalyticsRequest((AnalyticsRequest) request);
}
/**
* Initializes Analytics request.
*
*
* Default implementation does nothing. Called from
* {@link #initializeJsonRequest(com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest)}.
*
*
* @throws java.io.IOException I/O exception
*/
protected void initializeAnalyticsRequest(AnalyticsRequest request) throws java.io.IOException {
}
}