org.projectfloodlight.openflow.protocol.ver15.OFGroupRemoveBucketVer15 Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of openflowj Show documentation
Show all versions of openflowj Show documentation
OpenFlowJ API supporting OpenFlow versions 1.0 through 1.5.1, generated by LoxiGen
The newest version!
// Copyright (c) 2008 The Board of Trustees of The Leland Stanford Junior University
// Copyright (c) 2011, 2012 Open Networking Foundation
// Copyright (c) 2012, 2013 Big Switch Networks, Inc.
// This library was generated by the LoxiGen Compiler.
// See the file LICENSE.txt which should have been included in the source distribution
// Automatically generated by LOXI from template of_class.java
// Do not modify
package org.projectfloodlight.openflow.protocol.ver15;
import org.projectfloodlight.openflow.protocol.*;
import org.projectfloodlight.openflow.protocol.action.*;
import org.projectfloodlight.openflow.protocol.actionid.*;
import org.projectfloodlight.openflow.protocol.bsntlv.*;
import org.projectfloodlight.openflow.protocol.errormsg.*;
import org.projectfloodlight.openflow.protocol.meterband.*;
import org.projectfloodlight.openflow.protocol.instruction.*;
import org.projectfloodlight.openflow.protocol.instructionid.*;
import org.projectfloodlight.openflow.protocol.match.*;
import org.projectfloodlight.openflow.protocol.stat.*;
import org.projectfloodlight.openflow.protocol.oxm.*;
import org.projectfloodlight.openflow.protocol.oxs.*;
import org.projectfloodlight.openflow.protocol.queueprop.*;
import org.projectfloodlight.openflow.types.*;
import org.projectfloodlight.openflow.util.*;
import org.projectfloodlight.openflow.exceptions.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.List;
import com.google.common.collect.ImmutableList;
import java.util.Set;
import io.netty.buffer.ByteBuf;
import com.google.common.hash.PrimitiveSink;
import com.google.common.hash.Funnel;
class OFGroupRemoveBucketVer15 implements OFGroupRemoveBucket {
private static final Logger logger = LoggerFactory.getLogger(OFGroupRemoveBucketVer15.class);
// version: 1.5
final static byte WIRE_VERSION = 6;
final static int MINIMUM_LENGTH = 24;
// maximum OF message length: 16 bit, unsigned
final static int MAXIMUM_LENGTH = 0xFFFF;
private final static long DEFAULT_XID = 0x0L;
private final static OFGroup DEFAULT_GROUP_ID = OFGroup.ALL;
private final static List DEFAULT_BUCKETS = ImmutableList.of();
private final static List DEFAULT_PROPERTIES = ImmutableList.of();
// OF message fields
private final long xid;
private final OFGroupType groupType;
private final OFGroup group;
private final OFGroupBucket commandBucketId;
private final List buckets;
private final List properties;
//
// package private constructor - used by readers, builders, and factory
OFGroupRemoveBucketVer15(long xid, OFGroupType groupType, OFGroup group, OFGroupBucket commandBucketId, List buckets, List properties) {
if(groupType == null) {
throw new NullPointerException("OFGroupRemoveBucketVer15: property groupType cannot be null");
}
if(group == null) {
throw new NullPointerException("OFGroupRemoveBucketVer15: property group cannot be null");
}
if(commandBucketId == null) {
throw new NullPointerException("OFGroupRemoveBucketVer15: property commandBucketId cannot be null");
}
if(buckets == null) {
throw new NullPointerException("OFGroupRemoveBucketVer15: property buckets cannot be null");
}
if(properties == null) {
throw new NullPointerException("OFGroupRemoveBucketVer15: property properties cannot be null");
}
this.xid = U32.normalize(xid);
this.groupType = groupType;
this.group = group;
this.commandBucketId = commandBucketId;
this.buckets = buckets;
this.properties = properties;
}
// Accessors for OF message fields
@Override
public OFVersion getVersion() {
return OFVersion.OF_15;
}
@Override
public OFType getType() {
return OFType.GROUP_MOD;
}
@Override
public long getXid() {
return xid;
}
@Override
public OFGroupModCommand getCommand() {
return OFGroupModCommand.REMOVE_BUCKET;
}
@Override
public OFGroupType getGroupType() {
return groupType;
}
@Override
public OFGroup getGroup() {
return group;
}
@Override
public OFGroupBucket getCommandBucketId() {
return commandBucketId;
}
@Override
public List getBuckets() {
return buckets;
}
@Override
public List getProperties() {
return properties;
}
public OFGroupRemoveBucket.Builder createBuilder() {
return new BuilderWithParent(this);
}
static class BuilderWithParent implements OFGroupRemoveBucket.Builder {
final OFGroupRemoveBucketVer15 parentMessage;
// OF message fields
private boolean xidSet;
private long xid;
private boolean groupTypeSet;
private OFGroupType groupType;
private boolean groupSet;
private OFGroup group;
private boolean commandBucketIdSet;
private OFGroupBucket commandBucketId;
private boolean bucketsSet;
private List buckets;
private boolean propertiesSet;
private List properties;
BuilderWithParent(OFGroupRemoveBucketVer15 parentMessage) {
this.parentMessage = parentMessage;
}
@Override
public OFVersion getVersion() {
return OFVersion.OF_15;
}
@Override
public OFType getType() {
return OFType.GROUP_MOD;
}
@Override
public long getXid() {
return xid;
}
@Override
public OFGroupRemoveBucket.Builder setXid(long xid) {
this.xid = xid;
this.xidSet = true;
return this;
}
@Override
public OFGroupModCommand getCommand() {
return OFGroupModCommand.REMOVE_BUCKET;
}
@Override
public OFGroupType getGroupType() {
return groupType;
}
@Override
public OFGroupRemoveBucket.Builder setGroupType(OFGroupType groupType) {
this.groupType = groupType;
this.groupTypeSet = true;
return this;
}
@Override
public OFGroup getGroup() {
return group;
}
@Override
public OFGroupRemoveBucket.Builder setGroup(OFGroup group) {
this.group = group;
this.groupSet = true;
return this;
}
@Override
public OFGroupBucket getCommandBucketId() {
return commandBucketId;
}
@Override
public OFGroupRemoveBucket.Builder setCommandBucketId(OFGroupBucket commandBucketId) {
this.commandBucketId = commandBucketId;
this.commandBucketIdSet = true;
return this;
}
@Override
public List getBuckets() {
return buckets;
}
@Override
public OFGroupRemoveBucket.Builder setBuckets(List buckets) {
this.buckets = buckets;
this.bucketsSet = true;
return this;
}
@Override
public List getProperties() {
return properties;
}
@Override
public OFGroupRemoveBucket.Builder setProperties(List properties) {
this.properties = properties;
this.propertiesSet = true;
return this;
}
@Override
public OFGroupRemoveBucket build() {
long xid = this.xidSet ? this.xid : parentMessage.xid;
OFGroupType groupType = this.groupTypeSet ? this.groupType : parentMessage.groupType;
if(groupType == null)
throw new NullPointerException("Property groupType must not be null");
OFGroup group = this.groupSet ? this.group : parentMessage.group;
if(group == null)
throw new NullPointerException("Property group must not be null");
OFGroupBucket commandBucketId = this.commandBucketIdSet ? this.commandBucketId : parentMessage.commandBucketId;
if(commandBucketId == null)
throw new NullPointerException("Property commandBucketId must not be null");
List buckets = this.bucketsSet ? this.buckets : parentMessage.buckets;
if(buckets == null)
throw new NullPointerException("Property buckets must not be null");
List properties = this.propertiesSet ? this.properties : parentMessage.properties;
if(properties == null)
throw new NullPointerException("Property properties must not be null");
//
return new OFGroupRemoveBucketVer15(
xid,
groupType,
group,
commandBucketId,
buckets,
properties
);
}
public List removeBucketBasedOnCommandBucketId() {
if(commandBucketId == null)
throw new IllegalStateException("CommandBucketId is null");
if(commandBucketId.equals(OFGroupBucket.BUCKET_FIRST))
buckets.remove(0);
else if(commandBucketId.equals(OFGroupBucket.BUCKET_LAST))
buckets.remove(buckets.size()-1);
else if(commandBucketId.equals(OFGroupBucket.BUCKET_ALL))
buckets.removeAll(buckets);
return buckets;
}
public List removeBucketBasedOnSpecificIndex(int index) {
if(index <= buckets.size())
buckets.remove(index);
else
throw new IllegalStateException("Index is not valid");
return buckets;
}
}
static class Builder implements OFGroupRemoveBucket.Builder {
// OF message fields
private boolean xidSet;
private long xid;
private boolean groupTypeSet;
private OFGroupType groupType;
private boolean groupSet;
private OFGroup group;
private boolean commandBucketIdSet;
private OFGroupBucket commandBucketId;
private boolean bucketsSet;
private List buckets;
private boolean propertiesSet;
private List properties;
@Override
public OFVersion getVersion() {
return OFVersion.OF_15;
}
@Override
public OFType getType() {
return OFType.GROUP_MOD;
}
@Override
public long getXid() {
return xid;
}
@Override
public OFGroupRemoveBucket.Builder setXid(long xid) {
this.xid = xid;
this.xidSet = true;
return this;
}
@Override
public OFGroupModCommand getCommand() {
return OFGroupModCommand.REMOVE_BUCKET;
}
@Override
public OFGroupType getGroupType() {
return groupType;
}
@Override
public OFGroupRemoveBucket.Builder setGroupType(OFGroupType groupType) {
this.groupType = groupType;
this.groupTypeSet = true;
return this;
}
@Override
public OFGroup getGroup() {
return group;
}
@Override
public OFGroupRemoveBucket.Builder setGroup(OFGroup group) {
this.group = group;
this.groupSet = true;
return this;
}
@Override
public OFGroupBucket getCommandBucketId() {
return commandBucketId;
}
@Override
public OFGroupRemoveBucket.Builder setCommandBucketId(OFGroupBucket commandBucketId) {
this.commandBucketId = commandBucketId;
this.commandBucketIdSet = true;
return this;
}
@Override
public List getBuckets() {
return buckets;
}
@Override
public OFGroupRemoveBucket.Builder setBuckets(List buckets) {
this.buckets = buckets;
this.bucketsSet = true;
return this;
}
@Override
public List getProperties() {
return properties;
}
@Override
public OFGroupRemoveBucket.Builder setProperties(List properties) {
this.properties = properties;
this.propertiesSet = true;
return this;
}
//
@Override
public OFGroupRemoveBucket build() {
long xid = this.xidSet ? this.xid : DEFAULT_XID;
if(!this.groupTypeSet)
throw new IllegalStateException("Property groupType doesn't have default value -- must be set");
if(groupType == null)
throw new NullPointerException("Property groupType must not be null");
OFGroup group = this.groupSet ? this.group : DEFAULT_GROUP_ID;
if(group == null)
throw new NullPointerException("Property group must not be null");
if(!this.commandBucketIdSet)
throw new IllegalStateException("Property commandBucketId doesn't have default value -- must be set");
if(commandBucketId == null)
throw new NullPointerException("Property commandBucketId must not be null");
List buckets = this.bucketsSet ? this.buckets : DEFAULT_BUCKETS;
if(buckets == null)
throw new NullPointerException("Property buckets must not be null");
List properties = this.propertiesSet ? this.properties : DEFAULT_PROPERTIES;
if(properties == null)
throw new NullPointerException("Property properties must not be null");
return new OFGroupRemoveBucketVer15(
xid,
groupType,
group,
commandBucketId,
buckets,
properties
);
}
public List removeBucketBasedOnCommandBucketId() {
if(commandBucketId == null)
throw new IllegalStateException("CommandBucketId is null");
if(commandBucketId.equals(OFGroupBucket.BUCKET_FIRST))
buckets.remove(0);
else if(commandBucketId.equals(OFGroupBucket.BUCKET_LAST))
buckets.remove(buckets.size()-1);
else if(commandBucketId.equals(OFGroupBucket.BUCKET_ALL))
buckets.removeAll(buckets);
return buckets;
}
public List removeBucketBasedOnSpecificIndex(int index) {
if(index <= buckets.size())
buckets.remove(index);
else
throw new IllegalStateException("Index is not valid");
return buckets;
}
}
final static Reader READER = new Reader();
static class Reader implements OFMessageReader {
@Override
public OFGroupRemoveBucket readFrom(ByteBuf bb) throws OFParseError {
int start = bb.readerIndex();
// fixed value property version == 6
byte version = bb.readByte();
if(version != (byte) 0x6)
throw new OFParseError("Wrong version: Expected=OFVersion.OF_15(6), got="+version);
// fixed value property type == 15
byte type = bb.readByte();
if(type != (byte) 0xf)
throw new OFParseError("Wrong type: Expected=OFType.GROUP_MOD(15), got="+type);
int length = U16.f(bb.readShort());
if(length < MINIMUM_LENGTH)
throw new OFParseError("Wrong length: Expected to be >= " + MINIMUM_LENGTH + ", was: " + length);
if(bb.readableBytes() + (bb.readerIndex() - start) < length) {
// Buffer does not have all data yet
bb.readerIndex(start);
return null;
}
if(logger.isTraceEnabled())
logger.trace("readFrom - length={}", length);
long xid = U32.f(bb.readInt());
// fixed value property command == 5
short command = bb.readShort();
if(command != (short) 0x5)
throw new OFParseError("Wrong command: Expected=OFGroupModCommand.REMOVE_BUCKET(5), got="+command);
OFGroupType groupType = OFGroupTypeSerializerVer15.readFrom(bb);
// pad: 1 bytes
bb.skipBytes(1);
OFGroup group = OFGroup.read4Bytes(bb);
int bucketArrayLen = U16.f(bb.readShort());
// pad: 2 bytes
bb.skipBytes(2);
OFGroupBucket commandBucketId = OFGroupBucketSerializerVer15.readFrom(bb);
List buckets = ChannelUtils.readList(bb, bucketArrayLen, OFBucketVer15.READER);
List properties = ChannelUtils.readList(bb, length - (bb.readerIndex() - start), OFGroupPropVer15.READER);
OFGroupRemoveBucketVer15 groupRemoveBucketVer15 = new OFGroupRemoveBucketVer15(
xid,
groupType,
group,
commandBucketId,
buckets,
properties
);
if(logger.isTraceEnabled())
logger.trace("readFrom - read={}", groupRemoveBucketVer15);
return groupRemoveBucketVer15;
}
}
public void putTo(PrimitiveSink sink) {
FUNNEL.funnel(this, sink);
}
final static OFGroupRemoveBucketVer15Funnel FUNNEL = new OFGroupRemoveBucketVer15Funnel();
static class OFGroupRemoveBucketVer15Funnel implements Funnel {
private static final long serialVersionUID = 1L;
@Override
public void funnel(OFGroupRemoveBucketVer15 message, PrimitiveSink sink) {
// fixed value property version = 6
sink.putByte((byte) 0x6);
// fixed value property type = 15
sink.putByte((byte) 0xf);
// FIXME: skip funnel of length
sink.putLong(message.xid);
// fixed value property command = 5
sink.putShort((short) 0x5);
OFGroupTypeSerializerVer15.putTo(message.groupType, sink);
// skip pad (1 bytes)
message.group.putTo(sink);
// FIXME: skip funnel of bucketArrayLen
// skip pad (2 bytes)
OFGroupBucketSerializerVer15.putTo(message.commandBucketId, sink);
FunnelUtils.putList(message.buckets, sink);
FunnelUtils.putList(message.properties, sink);
}
}
public void writeTo(ByteBuf bb) {
WRITER.write(bb, this);
}
final static Writer WRITER = new Writer();
static class Writer implements OFMessageWriter {
@Override
public void write(ByteBuf bb, OFGroupRemoveBucketVer15 message) {
int startIndex = bb.writerIndex();
// fixed value property version = 6
bb.writeByte((byte) 0x6);
// fixed value property type = 15
bb.writeByte((byte) 0xf);
// length is length of variable message, will be updated at the end
int lengthIndex = bb.writerIndex();
bb.writeShort(U16.t(0));
bb.writeInt(U32.t(message.xid));
// fixed value property command = 5
bb.writeShort((short) 0x5);
OFGroupTypeSerializerVer15.writeTo(bb, message.groupType);
// pad: 1 bytes
bb.writeZero(1);
message.group.write4Bytes(bb);
// bucketArrayLen is length indicator for buckets, will be
// udpated when buckets has been written
int bucketArrayLenIndex = bb.writerIndex();
bb.writeShort(0);
// pad: 2 bytes
bb.writeZero(2);
OFGroupBucketSerializerVer15.writeTo(bb, message.commandBucketId);
int bucketsStartIndex = bb.writerIndex();
ChannelUtils.writeList(bb, message.buckets);
// update field length member bucketArrayLen
int bucketsLength = bb.writerIndex() - bucketsStartIndex;
bb.setShort(bucketArrayLenIndex, bucketsLength);
ChannelUtils.writeList(bb, message.properties);
// update length field
int length = bb.writerIndex() - startIndex;
if (length > MAXIMUM_LENGTH) {
throw new IllegalArgumentException("OFGroupRemoveBucketVer15: message length (" + length + ") exceeds maximum (0xFFFF)");
}
bb.setShort(lengthIndex, length);
}
}
@Override
public String toString() {
StringBuilder b = new StringBuilder("OFGroupRemoveBucketVer15(");
b.append("xid=").append(xid);
b.append(", ");
b.append("groupType=").append(groupType);
b.append(", ");
b.append("group=").append(group);
b.append(", ");
b.append("commandBucketId=").append(commandBucketId);
b.append(", ");
b.append("buckets=").append(buckets);
b.append(", ");
b.append("properties=").append(properties);
b.append(")");
return b.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (getClass() != obj.getClass())
return false;
OFGroupRemoveBucketVer15 other = (OFGroupRemoveBucketVer15) obj;
if( xid != other.xid)
return false;
if (groupType == null) {
if (other.groupType != null)
return false;
} else if (!groupType.equals(other.groupType))
return false;
if (group == null) {
if (other.group != null)
return false;
} else if (!group.equals(other.group))
return false;
if (commandBucketId == null) {
if (other.commandBucketId != null)
return false;
} else if (!commandBucketId.equals(other.commandBucketId))
return false;
if (buckets == null) {
if (other.buckets != null)
return false;
} else if (!buckets.equals(other.buckets))
return false;
if (properties == null) {
if (other.properties != null)
return false;
} else if (!properties.equals(other.properties))
return false;
return true;
}
@Override
public boolean equalsIgnoreXid(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (getClass() != obj.getClass())
return false;
OFGroupRemoveBucketVer15 other = (OFGroupRemoveBucketVer15) obj;
// ignore XID
if (groupType == null) {
if (other.groupType != null)
return false;
} else if (!groupType.equals(other.groupType))
return false;
if (group == null) {
if (other.group != null)
return false;
} else if (!group.equals(other.group))
return false;
if (commandBucketId == null) {
if (other.commandBucketId != null)
return false;
} else if (!commandBucketId.equals(other.commandBucketId))
return false;
if (buckets == null) {
if (other.buckets != null)
return false;
} else if (!buckets.equals(other.buckets))
return false;
if (properties == null) {
if (other.properties != null)
return false;
} else if (!properties.equals(other.properties))
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * (int) (xid ^ (xid >>> 32));
result = prime * result + ((groupType == null) ? 0 : groupType.hashCode());
result = prime * result + ((group == null) ? 0 : group.hashCode());
result = prime * result + ((commandBucketId == null) ? 0 : commandBucketId.hashCode());
result = prime * result + ((buckets == null) ? 0 : buckets.hashCode());
result = prime * result + ((properties == null) ? 0 : properties.hashCode());
return result;
}
@Override
public int hashCodeIgnoreXid() {
final int prime = 31;
int result = 1;
// ignore XID
result = prime * result + ((groupType == null) ? 0 : groupType.hashCode());
result = prime * result + ((group == null) ? 0 : group.hashCode());
result = prime * result + ((commandBucketId == null) ? 0 : commandBucketId.hashCode());
result = prime * result + ((buckets == null) ? 0 : buckets.hashCode());
result = prime * result + ((properties == null) ? 0 : properties.hashCode());
return result;
}
}