openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/AbstractErrorTranslator.java

   1 /**
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.openflowplugin.openflow.md.core.translator;
   9
  10 import org.opendaylight.openflowplugin.openflow.md.core.IMDMessageTranslator;
  11 import org.opendaylight.openflowplugin.openflow.md.core.SwitchConnectionDistinguisher;
  12 import org.opendaylight.openflowplugin.openflow.md.core.session.SessionContext;
  13 import org.opendaylight.openflowplugin.openflow.md.core.session.TransactionKey;
  14 import org.opendaylight.openflowplugin.openflow.md.util.ByteUtil;
  15 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Uri;
  16 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.errors.rev131116.ErrorType;
  17 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.NodeErrorNotification;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.NodeErrorNotificationBuilder;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.NodeFlow;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.node.error.reference.ObjectReference;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.node.error.reference.object.reference.FlowRefBuilder;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.node.error.reference.object.reference.GroupRefBuilder;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.node.error.reference.object.reference.MeterRefBuilder;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev131103.TransactionId;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev131103.TransactionMetadata;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.NodeGroup;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.NodeMeter;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ErrorMessage;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
  30 import org.opendaylight.yangtools.yang.binding.DataObject;
  31 import org.slf4j.Logger;
  32 import org.slf4j.LoggerFactory;
  33
  34 import java.math.BigInteger;
  35 import java.util.ArrayList;
  36 import java.util.Collections;
  37 import java.util.List;
  38 import java.util.concurrent.CopyOnWriteArrayList;
  39
  40 public abstract class AbstractErrorTranslator implements IMDMessageTranslator<OfHeader, List<DataObject>> {
  41
  42     protected static final Logger LOG = LoggerFactory.getLogger(AbstractErrorTranslator.class);
  43
  44     @Override
  45     public List<DataObject> translate(SwitchConnectionDistinguisher cookie, SessionContext sc, OfHeader msg) {
  46         if (msg instanceof ErrorMessage) {
  47             ErrorMessage message = (ErrorMessage) msg;
  48             List<DataObject> list = new CopyOnWriteArrayList<DataObject>();
  49             if (LOG.isDebugEnabled()) {
  50                 String hexData = "n/a";
  51                 if (message.getData() != null) {
  52                     hexData = ByteUtil.bytesToHexstring(message.getData(), " ");
  53                 }
  54                 LOG.debug(" Error Message received: type={}[{}], code={}[{}], data=[{}] ", message.getType(),
  55                         message.getTypeString(), message.getCode(), message.getCodeString(),
  56                         hexData);
  57
  58             }
  59
  60             // create a Node Error Notification event builder
  61             NodeErrorNotificationBuilder nodeErrBuilder = new NodeErrorNotificationBuilder();
  62
  63             // Fill in the Node Error Notification Builder object from the Error
  64             // Message
  65
  66             nodeErrBuilder.setTransactionId(new TransactionId(BigInteger.valueOf(message.getXid())));
  67
  68             Object object = null;
  69             if (sc != null) {
  70                 // sessionContext is available only after handshake finished
  71                 object = sc.getbulkTransactionCache().getIfPresent(new TransactionKey(message.getXid()));
  72             }
  73
  74             Uri uri = null;
  75             ObjectReference objRef = null;
  76             if(object != null) {
  77                 uri = ((TransactionMetadata) object).getTransactionUri();
  78                 objRef = getReference(object);
  79             }
  80
  81             nodeErrBuilder.setTransactionUri(uri);
  82             nodeErrBuilder.setObjectReference(objRef);
  83
  84             ErrorType type = decodeErrorType(message.getType());
  85             nodeErrBuilder.setType(type);
  86             nodeErrBuilder.setCode(message.getCode());
  87
  88             if (message.getData() != null) {
  89                 nodeErrBuilder.setData(new String(message.getData()));
  90             }
  91
  92             // TODO -- Augmentation is not handled
  93
  94             NodeErrorNotification nodeErrorEvent = nodeErrBuilder.build();
  95             list.add(nodeErrorEvent);
  96
  97             list.addAll(getGranularNodeErrors(message, type, uri, objRef));
  98
  99             return list;
 100         } else {
 101             LOG.error("Message is not of Error Message ");
 102             return Collections.emptyList();
 103         }
 104     }
 105
 106     private ObjectReference getReference(Object object) {
 107         if (object instanceof NodeFlow) {
 108             FlowEntityData flowEntry = new FlowEntityData();
 109             FlowRefBuilder flowRef = flowEntry.getBuilder(object);
 110             return flowRef.build();
 111
 112         } else if (object instanceof NodeGroup) {
 113             GroupEntityData groupEntry = new GroupEntityData();
 114             GroupRefBuilder groupRef = groupEntry.getBuilder(object);
 115             return groupRef.build();
 116
 117         } else if (object instanceof NodeMeter) {
 118             MeterEntityData meterEntry = new MeterEntityData();
 119             MeterRefBuilder meterRef = meterEntry.getBuilder(object);
 120             return meterRef.build();
 121
 122         }
 123         return null;
 124     }
 125
 126     protected List<DataObject> getGranularNodeErrors(ErrorMessage message, ErrorType errorType, Uri uri, ObjectReference objRef){
 127         // this is the impl for V1.0
 128         return new ArrayList<>();
 129     }
 130
 131     /**
 132      * @param type error type in source message
 133      */
 134     public abstract ErrorType decodeErrorType(int type);
 135
 136 }