org.jboss.aerogear.unifiedpush.api.AndroidVariant Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of unifiedpush-model-api Show documentation

There is a newer version: 2.5.0

Show newest version

/**
 * JBoss, Home of Professional Open Source
 * Copyright Red Hat, Inc., and individual contributors.
 *
 * 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.
 */
package org.jboss.aerogear.unifiedpush.api;

import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;

/**
 * The Android variant class encapsulates GCM specific behavior.
 */
public class AndroidVariant extends Variant {
    private static final long serialVersionUID = -4473752252296190311L;

    @NotNull
    @Size(min = 1, max = 255, message = "Google Cloud Messaging Key must be max. 255 chars long")
    private String googleKey;

    @Size(min = 1, max = 255, message = "Project Number must be max. 255 chars long")
    private String projectNumber;

    /**
     * The "Google Project Number" from the API Console is not needed for sending push messages, but it is a convenience to "see" it on
     * the Admin UI as well, since the Android applications require it (called Sender ID there). That way all informations are stored on the
     * same object.
     *
     * @return the Google project number string
     */
    public String getProjectNumber() {
        return projectNumber;
    }

    public void setProjectNumber(final String projectNumber) {
        this.projectNumber = projectNumber;
    }

    /**
     * The Google API Key from the Google API project, which has been enabled for Android-based GCM.
     *
      @return the Google API key
     */
    public String getGoogleKey() {
        return this.googleKey;
    }

    public void setGoogleKey(final String googleKey) {
        this.googleKey = googleKey;
    }

    @Override
    public VariantType getType() {
        return VariantType.ANDROID;
    }
}