org.apache.camel.component.github

Class GitHubEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.github.GitHubEndpoint

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

@UriEndpoint(scheme="github",
             title="GitHub",
             syntax="github:type/branchName",
             label="api,file")
public class GitHubEndpoint
extends org.apache.camel.impl.DefaultEndpoint

The endpoint encapsulates portions of the GitHub API, relying on the org.eclipse.egit.github.core Java SDK. Available endpoint URIs include: CONSUMERS github://pullRequest (new pull requests) github://pullRequestComment (new pull request comments) github://commit/[branch] (new commits) github://tag (new tags) PRODUCERS github://pullRequestComment (create a new pull request comment; see PullRequestCommentProducer for header requirements) The endpoints will respond with org.eclipse.egit.github.core-provided POJOs (PullRequest, CommitComment, RepositoryTag, RepositoryCommit, etc.) Note: Rather than webhooks, this endpoint relies on simple polling. Reasons include: - concerned about reliability/stability if this somehow relied on an exposed, embedded server (Jetty?) - the types of payloads we're polling aren't typically large (plus, paging is available in the API) - need to support apps running somewhere not publicly accessible where a webhook would fail

Field Summary

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
GitHubEndpoint(String uri, GitHubComponent component)

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor)
org.apache.camel.Producer	createProducer()
String	getBranchName()
String	getEncoding()
String	getOauthToken()
String	getPassword()
String	getRepoName()
String	getRepoOwner()
String	getState()
String	getTargetUrl()
GitHubType	getType()
String	getUsername()
boolean	hasOauth()
boolean	isSingleton()
void	setBranchName(String branchName)
void	setEncoding(String encoding)
void	setOauthToken(String oauthToken)
void	setPassword(String password)
void	setRepoName(String repoName)
void	setRepoOwner(String repoOwner)
void	setState(String state)
void	setTargetUrl(String targetUrl)
void	setType(GitHubType type)
void	setUsername(String username)

Methods inherited from class org.apache.camel.impl.DefaultEndpoint

configureConsumer, configurePollingConsumer, configureProperties, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, createPollingConsumer, doStart, doStop, equals, getCamelContext, getComponent, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExchangePattern, getId, getPollingConsumerQueueSize, hashCode, isLenientProperties, isPollingConsumerBlockWhenFull, isSynchronous, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExchangePattern, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

GitHubEndpoint

public GitHubEndpoint(String uri,
              GitHubComponent component)

Method Detail

createProducer

public org.apache.camel.Producer createProducer()
                                         throws Exception

Throws:

Exception

createConsumer

public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor)
                                         throws Exception

Throws:

Exception

isSingleton

public boolean isSingleton()

getType

public GitHubType getType()

setType

public void setType(GitHubType type)

getBranchName

public String getBranchName()

setBranchName

public void setBranchName(String branchName)

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

getOauthToken

public String getOauthToken()

setOauthToken

public void setOauthToken(String oauthToken)

hasOauth

public boolean hasOauth()

getRepoOwner

public String getRepoOwner()

setRepoOwner

public void setRepoOwner(String repoOwner)

getRepoName

public String getRepoName()

setRepoName

public void setRepoName(String repoName)

getState

public String getState()

setState

public void setState(String state)

getTargetUrl

public String getTargetUrl()

setTargetUrl

public void setTargetUrl(String targetUrl)

getEncoding

public String getEncoding()

setEncoding

public void setEncoding(String encoding)