com.softlayer.api.service.network.logging.Syslog Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
There is a newer version: 0.3.4
package com.softlayer.api.service.network.logging;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import java.util.GregorianCalendar;

/**
 * The Syslog class holds a single line from the Networking Firewall "Syslog" record, for firewall detected and blocked attempts on a server. 
 *
 * @see SoftLayer_Network_Logging_Syslog
 */
@ApiType("SoftLayer_Network_Logging_Syslog")
public class Syslog extends Entity {

    /**
     * Timestamp for when the connection was blocked by the firewall
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar createDate;

    public GregorianCalendar getCreateDate() {
        return createDate;
    }

    public void setCreateDate(GregorianCalendar createDate) {
        createDateSpecified = true;
        this.createDate = createDate;
    }

    protected boolean createDateSpecified;

    public boolean isCreateDateSpecified() {
        return createDateSpecified;
    }

    public void unsetCreateDate() {
        createDate = null;
        createDateSpecified = false;
    }

    /**
     * The Destination IP Address of the blocked connection (your end)
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String destinationIpAddress;

    public String getDestinationIpAddress() {
        return destinationIpAddress;
    }

    public void setDestinationIpAddress(String destinationIpAddress) {
        destinationIpAddressSpecified = true;
        this.destinationIpAddress = destinationIpAddress;
    }

    protected boolean destinationIpAddressSpecified;

    public boolean isDestinationIpAddressSpecified() {
        return destinationIpAddressSpecified;
    }

    public void unsetDestinationIpAddress() {
        destinationIpAddress = null;
        destinationIpAddressSpecified = false;
    }

    /**
     * The Destination Port of the blocked connection (your end)
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long destinationPort;

    public Long getDestinationPort() {
        return destinationPort;
    }

    public void setDestinationPort(Long destinationPort) {
        destinationPortSpecified = true;
        this.destinationPort = destinationPort;
    }

    protected boolean destinationPortSpecified;

    public boolean isDestinationPortSpecified() {
        return destinationPortSpecified;
    }

    public void unsetDestinationPort() {
        destinationPort = null;
        destinationPortSpecified = false;
    }

    /**
     * This tells you what kind of firewall event this log line is for:  accept or deny.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String eventType;

    public String getEventType() {
        return eventType;
    }

    public void setEventType(String eventType) {
        eventTypeSpecified = true;
        this.eventType = eventType;
    }

    protected boolean eventTypeSpecified;

    public boolean isEventTypeSpecified() {
        return eventTypeSpecified;
    }

    public void unsetEventType() {
        eventType = null;
        eventTypeSpecified = false;
    }

    /**
     * Raw syslog message for the event
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String message;

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        messageSpecified = true;
        this.message = message;
    }

    protected boolean messageSpecified;

    public boolean isMessageSpecified() {
        return messageSpecified;
    }

    public void unsetMessage() {
        message = null;
        messageSpecified = false;
    }

    /**
     * Connection protocol used to make the call that was blocked (tcp, udp, etc)
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String protocol;

    public String getProtocol() {
        return protocol;
    }

    public void setProtocol(String protocol) {
        protocolSpecified = true;
        this.protocol = protocol;
    }

    protected boolean protocolSpecified;

    public boolean isProtocolSpecified() {
        return protocolSpecified;
    }

    public void unsetProtocol() {
        protocol = null;
        protocolSpecified = false;
    }

    /**
     * The Source IP Address of the call that was blocked (attacker's end)
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String sourceIpAddress;

    public String getSourceIpAddress() {
        return sourceIpAddress;
    }

    public void setSourceIpAddress(String sourceIpAddress) {
        sourceIpAddressSpecified = true;
        this.sourceIpAddress = sourceIpAddress;
    }

    protected boolean sourceIpAddressSpecified;

    public boolean isSourceIpAddressSpecified() {
        return sourceIpAddressSpecified;
    }

    public void unsetSourceIpAddress() {
        sourceIpAddress = null;
        sourceIpAddressSpecified = false;
    }

    /**
     * The Source Port where the blocked connection was established (attacker's end)
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long sourcePort;

    public Long getSourcePort() {
        return sourcePort;
    }

    public void setSourcePort(Long sourcePort) {
        sourcePortSpecified = true;
        this.sourcePort = sourcePort;
    }

    protected boolean sourcePortSpecified;

    public boolean isSourcePortSpecified() {
        return sourcePortSpecified;
    }

    public void unsetSourcePort() {
        sourcePort = null;
        sourcePortSpecified = false;
    }

    /**
     * If this is an aggregation of syslog events, this property shows the total events.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long totalEvents;

    public Long getTotalEvents() {
        return totalEvents;
    }

    public void setTotalEvents(Long totalEvents) {
        totalEventsSpecified = true;
        this.totalEvents = totalEvents;
    }

    protected boolean totalEventsSpecified;

    public boolean isTotalEventsSpecified() {
        return totalEventsSpecified;
    }

    public void unsetTotalEvents() {
        totalEvents = null;
        totalEventsSpecified = false;
    }

    public static class Mask extends com.softlayer.api.service.Entity.Mask {

        public Mask createDate() {
            withLocalProperty("createDate");
            return this;
        }

        public Mask destinationIpAddress() {
            withLocalProperty("destinationIpAddress");
            return this;
        }

        public Mask destinationPort() {
            withLocalProperty("destinationPort");
            return this;
        }

        public Mask eventType() {
            withLocalProperty("eventType");
            return this;
        }

        public Mask message() {
            withLocalProperty("message");
            return this;
        }

        public Mask protocol() {
            withLocalProperty("protocol");
            return this;
        }

        public Mask sourceIpAddress() {
            withLocalProperty("sourceIpAddress");
            return this;
        }

        public Mask sourcePort() {
            withLocalProperty("sourcePort");
            return this;
        }

        public Mask totalEvents() {
            withLocalProperty("totalEvents");
            return this;
        }

    }

}