You are not logged in. Click here
to log in.
codebeamer Application Lifecycle Management (ALM)
This functionality can only be used in conjunction with Intland professional services. To become part of the early release community please contact sales@intland.com.
codeBeamer Listener APIThe codeBeamer server internally has a mechanism for dispatching EventsThe protocol by which events
public interface ProjectListener extends EventListener {
/**
* This method gets called when a new project is created.
* The {@link BaseEvent#getSource()} is the newly created project
* @throws VetoException if the listener wishes the change to be rolled back.
*/
default void projectCreated(BaseEvent<ProjectDto,Void,Void> event) throws VetoException {}
/**
* This method gets called when a project is updated.
* The {@link BaseEvent#getSource()} is the new/updated project state
* The {@link BaseEvent#getSecondarySource()} is the old project state before the update
* @param event contains the "new" state as "source" and the "old" state as "secondarySource", so you have access to both.
* @throws VetoException if the listener wishes the change to be rolled back.
*/
default void projectUpdated(BaseEvent<ProjectDto,ProjectDto,Void> event) throws VetoException {}
/**
* This method gets called when a project is deleted.
* The {@link BaseEvent#getSource()} is the deleted project
* @throws VetoException if the listener wishes the change to be rolled back.
*/
default void projectDeleted(BaseEvent<ProjectDto,Void,Void> event) throws VetoException {}
/**
* This method gets called when the daily project statistics are build (typically daily once a night).
* The {@link BaseEvent#getSource()} is the project whose statistics to build
* The {@link BaseEvent#getSecondarySource()} is the statistics anchor date.
* The {@link BaseEvent#getData()} are the {@link DailyProjectStatsDto}, but only in the post event notification.
* @throws VetoException if the listener wishes to not build statistics or this project.
* @since CB-6.0
*/
default void projectDailyStatistics(BaseEvent<ProjectDto,Date,DailyProjectStatsDto> event) throws VetoException {}
/**
* This method gets called when a user requested to join a project.
* The {@link BaseEvent#getSource()} is the project where the {@link BaseEvent#getUser()} wants to join
* The {@link BaseEvent#getSecondarySource()} is the comment of the user for the join request
* @param event
* @throws VetoException
*/
default void userJoinRequested (BaseEvent<ProjectDto,String,Void> event) throws VetoException {}
/**
* This method gets called when a project join request was accepted.
* The {@link BaseEvent#getSource()} is the project where the join was accepted by the {@link BaseEvent#getUser()}
* The {@link BaseEvent#getSecondarySource()} is the comment of the user who accepted the join
* The {@link BaseEvent#getData()} is the user whose join request was accepted.
* @param event
* @throws VetoException
*/
default void userJoinAccepted (BaseEvent<ProjectDto,String,UserDto> event) throws VetoException {}
/**
* This method gets called when a project join request was rejected
* The {@link BaseEvent#getSource()} is the project where the join was rejected by the {@link BaseEvent#getUser()}
* The {@link BaseEvent#getSecondarySource()} is the comment of the user who rejected the join
* The {@link BaseEvent#getData()} is the user whose join request was rejected.
* @param event
* @throws VetoException
*/
default void userJoinRejected (BaseEvent<ProjectDto,String,UserDto> event) throws VetoException {}
}
Information about the event  is passed as method parameters, typically in form of a generic BaseEvent object, that carries entity and event specific information:
All event communication occurs
exceptions during listener notification will cause a transaction rollback !ListingHere is a listing of all codeBeamer listener
Please refer to the documentation of a specific entity listener ListenersA codeBeamer Event
Default ListenersCodeBeamer includes a set of default Listeners
Custom ListenersWe recommend, that the package
package com.intland.codebeamer.event.impl.sample;
import org.springframework.stereotype.Component;
import com.intland.codebeamer.event.ProjectListener;
@Component("exampleProjectListener")
public class ExampleProjectListener implements ProjectListener {
}
Unless you want to replace a Default Listener (see above) with an extended/custom version, you must not
If a Listener class needs access to other CodeBeamer APIs, it should simply declare appropriate @Autowired variables, e.g.
package com.intland.codebeamer.event.impl.sample;
import org.springframework.stereotype.Component;
import com.intland.codebeamer.event.ProjectListener;
import com.intland.codebeamer.manager.ProjectManager;
@Component("exampleProjectListener")
public class ExampleProjectListener implements ProjectListener {
@Autowired
private ProjectManager projectManager;
...
}
package com.intland.codebeamer.event.impl.sample;
import org.springframework.stereotype.Component;
import com.intland.codebeamer.event.BaseEvent;
import com.intland.codebeamer.event.ProjectListener;
import com.intland.codebeamer.event.util.VetoException;
import com.intland.codebeamer.persistence.dto.ProjectDto;
@Component("exampleProjectListener")
public class ExampleProjectListener implements ProjectListener {
@Override
public void projectCreated(BaseEvent<ProjectDto, Void, Void> event) throws VetoException {
ProjectDto project = event.getSource();
if (event.isPreEvent() && project.getCategoryReference() == null) {
throw new VetoException("Each project must have a category!");
}
}
}
In CB-10.1 and newer, you only need to override Java IDEDeveloping a custom Listener
DeploymentTo deploy your custom Listener ~/CB-../tomcat/webapps/cb/WEB-INF/classes/my-ApplicationContext.xml Finally you have to restart CodeBeamer, for your newly deployed Listeners to get loaded. Please note:
Frequently Asked Questions
You can simply leave those method bodies empty, it has no side-effects at all.
No. codeBeamer relies on actively using its own listeners to implement several mechanisms. Disabling the default listeners might result in undefined behavior and data failure.
No, there is absolutely no guarantee for which order they receive the notifications. Please don not rely on this.
No. If the listeners are normally notified in this order A, B, C, D and B vetoes the operation, then:
This is a design decision to keep the behavior simple, but powerful enough for most real-life applications. |
codebeamer Overview codebeamer Knowledge Base Services by Intland Software |
This website stores cookies on your computer. These cookies are used to improve your browsing experience, constantly optimize the functionality and content of our website, furthermore helps us to understand your interests and provide more personalized services to you, both on this website and through other media. With your permission we and our partners may use precise geolocation data and identification through device scanning. You may click accept to consent to our and our partners’ processing as described above. Please be aware that some processing of your personal data may not require your consent, but you have a right to object to such processing. By using our website, you acknowledge this notice of our cookie practices. By accepting and continuing to browse this site, you agree to this use. For more information about the cookies we use, please visit our Privacy Policy.Your preferences will apply to this website only.
anonymous
Hotkeys