How to use

register

method

in

org.springframework.batch.core.listener.MulticasterBatchListener

/**
 * Register a listener for callbacks at the appropriate stages in a process.
 *
 * @param listener a {@link StepListener}
 */
public void registerListener(StepListener listener) {
  this.listener.register(listener);
}

/**
 * Register a listener for callbacks at the appropriate stages in a process.
 *
 * @param listener a {@link StepListener}
 */
public void registerListener(StepListener listener) {
  this.listener.register(listener);
}

/**
 * Register each of the objects as listeners. Once registered, calls to the
 * {@link MulticasterBatchListener} broadcast to the individual listeners.
 *
 * @param listeners listener objects of types known to the multicaster.
 */
public void setListeners(List<? extends StepListener> listeners) {
  for (StepListener stepListener : listeners) {
    register(stepListener);
  }
}

/**
 * Register a listener for callbacks at the appropriate stages in a process.
 *
 * @param listener a {@link StepListener}
 */
public void registerListener(StepListener listener) {
  this.listener.register(listener);
}

/**
 * Register a listener for callbacks at the appropriate stages in a process.
 *
 * @param listener a {@link StepListener}
 */
@Override
public void registerListener(StepListener listener) {
  getListener().register(listener);
}

@Before
public void setUp() {
  multicast.register(new CountingStepListenerSupport());
}

/**
 * Test method for
 * {@link org.springframework.batch.core.listener.MulticasterBatchListener#onSkipInWrite(java.lang.Object, java.lang.Throwable)}
 * .
 */
@Test
public void testOnSkipInProcess() {
  multicast.register(new SkipListenerSupport<Object,Object>() {
    @Override
    public void onSkipInProcess(Object item, Throwable t) {
      count++;
      super.onSkipInWrite(item, t);
    }
  });
  multicast.onSkipInProcess(null, new RuntimeException("foo"));
  assertEquals(1, count);
}

/**
 * Test method for
 * {@link org.springframework.batch.core.listener.MulticasterBatchListener#onSkipInWrite(java.lang.Object, java.lang.Throwable)}
 * .
 */
@Test
public void testOnSkipInWrite() {
  multicast.register(new SkipListenerSupport<Object,Object>() {
    @Override
    public void onSkipInWrite(Object item, Throwable t) {
      count++;
      super.onSkipInWrite(item, t);
    }
  });
  multicast.onSkipInWrite(null, new RuntimeException("foo"));
  assertEquals(1, count);
}

/**
 * Test method for
 * {@link org.springframework.batch.core.listener.MulticasterBatchListener#onSkipInRead(java.lang.Throwable)}
 * .
 */
@Test
public void testOnSkipInRead() {
  multicast.register(new SkipListenerSupport<Object,Object>() {
    @Override
    public void onSkipInRead(Throwable t) {
      count++;
      super.onSkipInRead(t);
    }
  });
  multicast.onSkipInRead(new RuntimeException("foo"));
  assertEquals(1, count);
}

/**
 * Test method for
 * {@link org.springframework.batch.core.listener.MulticasterBatchListener#onSkipInRead(java.lang.Throwable)}
 * .
 */
@Test
public void testOnSkipInReadFails() {
  multicast.register(new SkipListenerSupport<Object,Object>() {
    @Override
    public void onSkipInRead(Throwable t) {
      count++;
      throw new RuntimeException("foo");
    }
  });
  try {
    multicast.onSkipInRead(new RuntimeException("bar"));
    fail("Expected RuntimeException");
  }
  catch (RuntimeException e) {
    // expected
    String message = e.getMessage();
    assertEquals("Wrong message: " + message, "foo", message);
  }
  assertEquals(1, count);
}

/**
 * Test method for
 * {@link org.springframework.batch.core.listener.MulticasterBatchListener#onSkipInWrite(java.lang.Object, java.lang.Throwable)}
 * .
 */
@Test
public void testOnSkipInProcessFails() {
  multicast.register(new SkipListenerSupport<Object,Object>() {
    @Override
    public void onSkipInProcess(Object item, Throwable t) {
      count++;
      throw new RuntimeException("foo");
    }
  });
  try {
    multicast.onSkipInProcess(null, new RuntimeException("bar"));
    fail("Expected RuntimeException");
  }
  catch (RuntimeException e) {
    // expected
    String message = e.getMessage();
    assertEquals("Wrong message: " + message, "foo", message);
  }
  assertEquals(1, count);
}

@Test
public void testBeforeChunkFails_withAnnotatedListener() {
  StepListener listener = StepListenerFactoryBean.getListener(new AnnotationBasedStepListener());
  multicast.register(listener);
  try {
    multicast.beforeChunk(null);
    fail("Expected StepListenerFailedException");
  } catch (StepListenerFailedException e) {
    // expected
    Throwable cause = e.getCause();
    String message = cause.getMessage();
    assertTrue(cause instanceof IllegalStateException);
    assertEquals("Wrong message: " + message, "listener error", message);
  }
}

@Test
public void testBeforeReadFails_withAnnotatedListener() {
  StepListener listener = StepListenerFactoryBean.getListener(new AnnotationBasedStepListener());
  multicast.register(listener);
  try {
    multicast.beforeRead();
    fail("Expected StepListenerFailedException");
  } catch (StepListenerFailedException e) {
    // expected
    Throwable cause = e.getCause();
    String message = cause.getMessage();
    assertTrue(cause instanceof IllegalStateException);
    assertEquals("Wrong message: " + message, "listener error", message);
  }
}

@Test
public void testBeforeProcessFails_withAnnotatedListener() {
  StepListener listener = StepListenerFactoryBean.getListener(new AnnotationBasedStepListener());
  multicast.register(listener);
  try {
    multicast.beforeProcess(null);
    fail("Expected StepListenerFailedException");
  } catch (StepListenerFailedException e) {
    // expected
    Throwable cause = e.getCause();
    String message = cause.getMessage();
    assertTrue(cause instanceof IllegalStateException);
    assertEquals("Wrong message: " + message, "listener error", message);
  }
}

@Test
public void testBeforeWriteFails_withAnnotatedListener() {
  StepListener listener = StepListenerFactoryBean.getListener(new AnnotationBasedStepListener());
  multicast.register(listener);
  try {
    multicast.beforeWrite(null);
    fail("Expected StepListenerFailedException");
  } catch (StepListenerFailedException e) {
    // expected
    Throwable cause = e.getCause();
    String message = cause.getMessage();
    assertTrue(cause instanceof IllegalStateException);
    assertEquals("Wrong message: " + message, "listener error", message);
  }
}

@Test
public void testAfterProcessFails_withAnnotatedListener() {
  StepListener listener = StepListenerFactoryBean.getListener(new AnnotationBasedStepListener());
  multicast.register(listener);
  try {
    multicast.afterProcess(null, null);
    fail("Expected StepListenerFailedException");
  } catch (StepListenerFailedException e) {
    // expected
    Throwable cause = e.getCause();
    String message = cause.getMessage();
    assertTrue(cause instanceof IllegalStateException);
    assertEquals("Wrong message: " + message, "listener error", message);
  }
}

/**
 * Test method for
 * {@link org.springframework.batch.core.listener.MulticasterBatchListener#register(org.springframework.batch.core.StepListener)}
 * .
 */
@Test
public void testRegister() {
  JobExecution jobExecution = new JobExecution(1L);
  StepExecution stepExecution = new StepExecution("s1", jobExecution);
  multicast.register(new StepListenerSupport<Integer, String>() {
    @Override
    public ExitStatus afterStep(StepExecution stepExecution) {
      count++;
      return super.afterStep(stepExecution);
    }
  });
  multicast.afterStep(stepExecution);
  assertEquals(2, count);
}

@Test
public void testAfterReadFails_withAnnotatedListener() {
  StepListener listener = StepListenerFactoryBean.getListener(new AnnotationBasedStepListener());
  multicast.register(listener);
  try {
    multicast.afterRead(null);
    fail("Expected StepListenerFailedException");
  } catch (StepListenerFailedException e) {
    // expected
    Throwable cause = e.getCause();
    String message = cause.getMessage();
    assertTrue(cause instanceof IllegalStateException);
    assertEquals("Wrong message: " + message, "listener error", message);
  }
}

@Test
public void testAfterWriteFails_withAnnotatedListener() {
  StepListener listener = StepListenerFactoryBean.getListener(new AnnotationBasedStepListener());
  multicast.register(listener);
  try {
    multicast.afterWrite(null);
    fail("Expected StepListenerFailedException");
  } catch (StepListenerFailedException e) {
    // expected
    Throwable cause = e.getCause();
    String message = cause.getMessage();
    assertTrue(cause instanceof IllegalStateException);
    assertEquals("Wrong message: " + message, "listener error", message);
  }
}

@Test
public void testAfterChunkFails_withAnnotatedListener() {
  StepListener listener = StepListenerFactoryBean.getListener(new AnnotationBasedStepListener());
  multicast.register(listener);
  try {
    multicast.afterChunk(null);
    fail("Expected StepListenerFailedException");
  } catch (StepListenerFailedException e) {
    // expected
    Throwable cause = e.getCause();
    String message = cause.getMessage();
    assertTrue(cause instanceof IllegalStateException);
    assertEquals("Wrong message: " + message, "listener error", message);
  }
}